Repository navigation
Fix up use of API doc references in the changelog - #2098
Merged
Merged
Conversation
This was referenced Feb 14, 2014
Merged
Contributor
|
👍 |
Member
|
👍 |
embray
added a commit
that referenced
this pull request
Apr 17, 2014
Fix up use of API doc references in the changelog
embray
added a commit
that referenced
this pull request
Apr 23, 2014
Fix up use of API doc references in the changelog Conflicts: CHANGES.rst
embray
added a commit
that referenced
this pull request
Apr 23, 2014
Fix up use of API doc references in the changelog Conflicts: CHANGES.rst
Merged
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
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.
Removed several instances where single-backticks were used around words that do not correspond to any references in the docs. But also converted those that were references to the API docs to double-backticks, for two reasons:
Use of double vs single backticks have not been used consistently
in the changelog to begin with; for the sake of consistency
double-backticks is by far the easier default to fall back on.
This is intended to be a long-term document, and many API references
will become invalid over its history. Several are already invalid.
While it is highly useful to link to valid API docs from a
long-term maintenance view it is easier not to.
Also a few small typo and wording fixes here and there.
It's a shame to give up the API references that did work, and if anyone feels strongly about it I can go back at least through those that are still relevant and update them.
In the future I'm thinking of adopting a slightly different changelog format, where instead we only use CHANGES.rst for the "current" release series, and maybe a HISTORY.rst for older releases. That might also alleviate this issue, though I haven't given it full consideration yet.