Skip to content

Update Mix.Task.preferred_cli_env/1 docs #13114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 16, 2023

Conversation

wojtekmach
Copy link
Member

@wojtekmach wojtekmach commented Nov 16, 2023

ExDoc main emitted the following warning on Elixir main:

    warning: documentation references function "Mix.CLI.preferred_cli_env/1" but it is hidden
    │
  1 │ defmodule Mix.Task do
    │ ~~~~~~~~~~~~~~~~~~~~~
    │
    └─ (mix 1.17.0-dev) lib/mix/lib/mix/task.ex:1: Mix.Task.preferred_cli_env/1

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:

image

After:

image

@josevalim josevalim merged commit df66d88 into elixir-lang:main Nov 16, 2023
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants