Concept pages in nimi-python documentation do not exist, hyperlinks do not work.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
In many places throughout the nimi-python documentation, broken hyperlinks that look similar to "<REPLACE_DRIVER_SPECIFIC_URL_2(array_measurements_refs)>" are present. They are generated this way from the internal hapigen metadata. This should be addressed when nimi-python documentation is improved. For examples, see methods like configure_horizontal_timing or self_cal in the generated NI-SCOPE documentation.
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 inspecting docs/niscope/class.rst and the configure_horizontal_timing or self_cal entries cited in the issue. Trace how hapigen metadata generates placeholders such as <REPLACE_DRIVER_SPECIFIC_URL_2(array_measurements_refs)>. Done means the relevant concept pages exist and the generated documentation hyperlinks no longer contain broken placeholders.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100