Enumerated attributes should have a link points to its enum
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
From developer's point of view, it will be great that on the documentation for an enumerated attribute such as (nidcpower) auto_zero should have link to its enum to show the list of possible values. Currently only the Datatype shows an "enums" keyword for example enums.AutoZero and developers/users need to expand the "Enums" to look for the corresponding enum.
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
Start by locating the documentation generation or rendering entry point for enumerated attributes such as nidcpower auto_zero and the Enums section. Trace how the Datatype currently exposes enums.AutoZero, then determine how the rendered attribute can link directly to that enum; done means the documentation shows a usable link to the corresponding enum values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100