ni / ni/nimi-python

Add "deprecated" functions, enums, enum values, attributes to nimi-python's code generator

Open
#1,584 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Description

Description of issue

We need the ability to mark functions as "deprecated" in metadata so that the codegenerator does the appropriate thing:

  • DeprecationWarning
  • remove from ReadTheDocs or mark it as deprecated

This is needed for #1403

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating nimi-python's metadata handling and code generator, then read issue #1403 for the required deprecation use case. The work is done when deprecated functions, enums, enum values, and attributes produce DeprecationWarning and are removed from ReadTheDocs or clearly marked as deprecated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.