Eliminate `type_in_documentation` key in metadata
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
For attributes that have attribute_class key in metadata (e.g. AttributeViReal64TimeDeltaSeconds) and for method parameters that have python_api_converter_name key in metadata (e.g. convert_timedelta_to_seconds_real64), there is an additional key - type_in_documentation.
There is enough information in attribute_class and python_api_converter_name to figure out what the type in documentation should be. type_in_documentation is redundant and we can get rid of them.
This redundancy is especially bad for timedelta type given a large number of timedelta objects are used.
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 the type_in_documentation, attribute_class, and python_api_converter_name metadata keys, including the examples named in the issue. Confirm how documentation types are derived, remove the redundant key entries, and verify that generated documentation still reports the intended types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100