Fixed words replacement logic in documentation codegen breaks hyperlinks
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
We are replacing words like attributes with properties in documentation helper in an effort to standardize on these terminologies. This logic ends up changing the text in hyperlinks as well. The codegen should somehow know to skip the hyperlinks while doing this replacing.
System report
Steps to reproduce issue
If any API has a hyperlink in its documentation which contains words like attribute, then the generated class.rst and session.py will show a broken hyperlink.
Check help of select_arb_waveform function in RFSG.
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
Reproduce the problem by checking the RFSG select_arb_waveform help and comparing the generated class.rst and session.py. Start with the documentation helper's fixed-word replacement logic. Done means terminology changes apply to ordinary text while hyperlink targets remain unchanged and the generated links are valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100