You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
automatically replace references in docs with a link, if they are referencing a concept elsewhere.
Something similar to what we see in Wikipedia... Or sort of like Jira , where the parser sees something that might be a ticket name SUP-100, looks up to see if there's a ticket with that ID, and if so, replaces the text with a link to it.
So if you have a class "ClassyPythonClass" and there's a doc section for it (either pre-written or generated from docstrings perhaps), then the first reference in another section to that class could be a link to the docs for it.
The text was updated successfully, but these errors were encountered:
A friend said:
automatically replace references in docs with a link, if they are referencing a concept elsewhere.
Something similar to what we see in Wikipedia... Or sort of like Jira , where the parser sees something that might be a ticket name SUP-100, looks up to see if there's a ticket with that ID, and if so, replaces the text with a link to it.
So if you have a class "ClassyPythonClass" and there's a doc section for it (either pre-written or generated from docstrings perhaps), then the first reference in another section to that class could be a link to the docs for it.
The text was updated successfully, but these errors were encountered: