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.

Sign up for GitHub

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

Jump to bottom

Add context on current module for @ref link's #1714

Open

logankilpatrick opened this issue Oct 16, 2021 · 1 comment

Labels

Type: Documentation

Contributor

logankilpatrick commented Oct 16, 2021

Here: https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@ref-link it says:

Note that depending on what the CurrentModule is set to, a docstring @ref may need to be prefixed by the module which defines it.

Does this take into account submodules? Or only top level modules?

Contributor Author

logankilpatrick commented Oct 16, 2021

An example of this: FluxML/Flux.jl#1748

odow added the Type: Documentation label

odow mentioned this issue

Meta: suggestions for documentation improvements #2321

Open

28 tasks

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