[4.3] Change Edit on GitHub link to point to master #10376
Merged
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 has been discussed a few times in RC. The choice here is between having the link point to 4.3, and receiving 4.3 PRs which as a general rule we do not accept, or having the link point to master, and a slight chance that a page is renamed/moved and 404s.
From my cursory knowledge of RTD, I think this changing this field won't have any side effects, it only affects the construction of the URL.
But I'm not 100% sure and I couldn't find out for sure in the RTD source.It was in the RTD Sphinx theme, not the RTD main repo. This seems to be the only usage of this config value, so it seems like there will be no side effects:https://github.com/readthedocs/sphinx_rtd_theme/blob/8d4d394dad2d55cf9a4db880effac6aa5c7b12e6/sphinx_rtd_theme/breadcrumbs.html#L39
(And, when we branch the docs to a stable minor version in the future, we should leave this field as
master
rather than the new minor version.)