HDX-9727 Fix FIXTHIS #76
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes the FIXTHIS placeholder for URLs found in documentation of the API. There are two types of instance of this, one where a reference is made to other content in the API docs - these are replaced with relative links with a
target="_blank"attribute to make them open in a separate browser tab.The second type of instance is a reference to a overview/summary in the
readthedocsdocumentation. These are implemented by adding an entry to theconfigobject which is re-used as required. Sometimes this is in docstrings, this is implemented by an assignment to[func].__doc__so that f-string formatting can be used. It may be preferrable to make these updates in the conventional docstring as a simple search and replace.At some point instances of
placeholder.urlwill need to be replaced - these are all found in Markdown files so a simple search and replace should be sufficient.