Remove documentation key from metadata of private methods
Open
Nobody has claimed this yet.
docs
nidigital
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
Metadata of many private non-public (private, codegen-only etc.) methods include documentation key like:
'documentation': {
'description': 'TBD'
},
In some instances the content is TBD. Given the methods are private, we can remove the documentation key from metadata.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository for metadata entries containing the documentation key, especially those describing private or other non-public methods. Review which entries are excluded from the public API, remove the key from those metadata records, and verify that public method documentation remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100