Skip to content

Fixed words replacement logic in documentation codegen breaks hyperlinks #2119

@vnktshr21

Description

@vnktshr21

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions