Check for english specific doc links #225
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
It is a common error to see links like "https://hatch-jupyter-builder.readthedocs.io/en/latest", which point to the English version of the docs, rather than the generic link which uses the browser language https://hatch-jupyter-builder.readthedocs.io. Signed-off-by: Mark Anderson <manderson@anaconda.com>
Signed-off-by: Mark Anderson <manderson@anaconda.com>
Signed-off-by: Mark Anderson <manderson@anaconda.com>
marcoesters
reviewed
May 3, 2023
| @@ -488,6 +488,22 @@ def test_missing_documentation_bad(base_yaml): | |||
| assert len(messages) == 1 and "doc_url or doc_source_url" in messages[0].title | |||
|
|
|||
|
|
|||
| def test_documentation_specifies_language(base_yaml): | |||
There was a problem hiding this comment.
Can you add a test that also makes sure there are no messages when the link is generic to test for false positives?
|
I'm good with this, barring Marco's comments are resolved. |
Co-authored-by: Marco Esters <mesters@anaconda.com>
Co-authored-by: Marco Esters <mesters@anaconda.com>
Co-authored-by: Marco Esters <mesters@anaconda.com>
Co-authored-by: Marco Esters <mesters@anaconda.com>
schuylermartin45
approved these changes
Jul 12, 2023
marcoesters
approved these changes
Jul 12, 2023
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.
Check for english specific doc links
It is a common error to see links like "https://hatch-jupyter-builder.readthedocs.io/en/latest", which point to the English version of the docs, rather than the generic link which uses the browser language https://hatch-jupyter-builder.readthedocs.io.