Fix Adar1 repr doc links pointing to Adir1 (copy-paste error)#1235
Open
Pratik-911 wants to merge 1 commit intomalariagen:masterfrom
Open
Fix Adar1 repr doc links pointing to Adir1 (copy-paste error)#1235Pratik-911 wants to merge 1 commit intomalariagen:masterfrom
Pratik-911 wants to merge 1 commit intomalariagen:masterfrom
Conversation
This file contains hidden or 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
1 participant
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.
What
Fixes
__repr__and_repr_html_inAdar1— both documentation links incorrectly point toAdir1.htmlinstead ofAdar1.html.Why
Copy-paste error from when
adar1.pywas created usingadir1.pyas a template (see commit ccc6592). The doc URL and link text were never updated to reference the correct species.Changes
__repr__):Adir1.html→Adar1.html_repr_html_):Adir1.html→Adar1.htmlandAdir1 API docs→Adar1 API docsImpact
Users calling
repr()on anAdar1instance or viewing it in a Jupyter notebook are currently directed to the wrong API documentation page.