Skip to content

Conversation

eksperimental
Copy link
Contributor

No description provided.

@eksperimental eksperimental force-pushed the skip_reference_warnings_to branch from 292d0eb to e9ed687 Compare August 19, 2020 06:59
@eksperimental
Copy link
Contributor Author

There are two features that can be discussed, but are not intended to be covered by this PR:

  1. Whether we want to support Mix tasks. ie. "mix foo", instead of using the Mix.Tasks.TASKNAME module.

  2. Whether we want to skip references to a a module and everything inside (functions, types, etc). As of now, listing the Module would ignore the warning for that module in particular, but nothing else.

@josevalim
Copy link
Member

Do you have any example of when we would use this feature?

@eksperimental
Copy link
Contributor Author

eksperimental commented Sep 3, 2020

@josevalim Sorry, it was in the commit log, but since it originally had two commits, it wasn't clear.

Closes #1192
Addresses #1151 (comment)

@eksperimental
Copy link
Contributor Author

eksperimental commented Sep 3, 2020

Basically when mentioning a hidden reference (i.e. with doc false), such as in #1151 (comment)

where calling ExUnit.Case.__using__/1, which is a macro with @doc false and it will emit a warning when referencing it.

This way we can mention a public reference that has no documentation and don't get a warning.

@josevalim
Copy link
Member

@eksperimental oh, I see. I wonder if we can tackle this in some other way. Having to change a completely unrelated config file for a mistake happening in the documentation elsewhere is not very clear. Maybe we can use triple backticks to denote code sections with no syntax highlighting. We would need to change markdown first. For now, I will fix this in Elixir by referring to the function indirectly. Thank you!

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.

3 participants