ni / ni/nimi-python

Documentation references methods that don't exist

Open
#1,103 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of issue

In #1086 this issue was introuced. This issue is to make sure it's a known issue and gets tracked.

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 reading issue #1086 to identify the documentation changes that introduced references to nonexistent methods. Locate those references in the repository and determine which methods they should describe; the work is done when the documentation no longer points to unavailable methods and the affected references are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.