Document Aliases #2428
Merged
Document Aliases #2428
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
shlevy
approved these changes
Sep 17, 2018
|
I'm not sure we should document these, being deprecated and all. There are many more aliases BTW. |
|
I think they should be documented as being aliased now, so people can find the relevant docs from their configuration. I've seen several people confused about undocumented (because they're aliased) options. Maybe not as a second |
|
Another option could be documenting them as separate options, with the body of the varlistentry being "Deprecated: now an alias to newthing"? |
grahamc
force-pushed
the
docs-aliases
branch
from
b9dff47
to
a6ef765
Compare
grahamc
force-pushed
the
docs-aliases
branch
from
11ace1d
to
0cd8631
Compare
grahamc
changed the title
|
I've now documented all aliases which exist, where the option the alias is for was already documented. |
|
Thanks! |
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.
Please also backport to 2.1.