-
Notifications
You must be signed in to change notification settings - Fork 351
Skip reference warnings to #1249
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
Skip reference warnings to #1249
Conversation
292d0eb
to
e9ed687
Compare
There are two features that can be discussed, but are not intended to be covered by this PR:
|
Do you have any example of when we would use this feature? |
@josevalim Sorry, it was in the commit log, but since it originally had two commits, it wasn't clear. |
Basically when mentioning a hidden reference (i.e. with doc false), such as in #1151 (comment) where calling This way we can mention a public reference that has no documentation and don't get a warning. |
@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! |
No description provided.