Update Mix.Task.preferred_cli_env/1 docs #13114
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.
ExDoc main emitted the following warning on Elixir main:
and the warning was pointing to the wrong location. Not sure if it's worth addressing but here's what happened:
defdelegate
without explicit@doc
adds the@doc "See <delegating_to>"
however here we're delegating to a module with@moduledoc false
hence the warning.I decided to just update the docs. At some point I imagine this function would become a
@doc false
anyway.Before:
After: