Document that consolidate_protocols is enabled by default #5091
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
Didn't know about this (and apparently several other people who asked me if I had it enabled as well) so I thought it'd be good to mention, I like defaults being mentioned in the docs in general :)
lib/mix/lib/mix/tasks/app.start.ex
Outdated
| * `:consolidate_protocols` - when `true`, loads consolidated | ||
| protocols before start | ||
| protocols before start. Enabled by default. |
Member
There was a problem hiding this comment.
Maybe we could say "The default value is true" to be 100% clear? Wdyt?
Contributor
Author
There was a problem hiding this comment.
Sure, will get to it. Thanks!
Contributor
Author
|
Updated! |
Member
|
|
!
josevalim
pushed a commit
that referenced
this pull request
Aug 4, 2016
…5091) Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Didn't know about this (and apparently several other people who
asked me if I had it enabled as well) so I thought it'd be good
to mention, I like defaults being mentioned in the docs
in general :)
As by this default configuration. I also think it'd be nice to mention the project default configuration in Mix.Project docs, but that's prone to error. I thought about making
default_configpublic, and adding a doc test for it. Sure, annoying to update but that way the docs would stay up to date and people would have an easy reference for the default configuration without digging through the code. I'd be happy to add that in as well if desired :)Also for compile/app.start might want to add the other default values in the docs.
Thanks!
Tobi