Skip to content
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

Search only matches the word before a fullstop (e.g. Module.function_name finds Module but not function_name) #5

Open
zygmuntszpak opened this issue Jan 21, 2018 · 1 comment

Comments

@zygmuntszpak
Copy link

When writing a docstring, If one writes something like

See also: Kernel.ando3 (i.e. (Kernel.ando3 with backticks around Kernel.ando)

where Kernel is a module, then currently the documentation browser will not find the function ando3 defined in the Kernel module, but instead will match the first part of the word and try to bring up documentation for Kernel if it exists.

@pfitzseb
Copy link
Member

It's not entirely correct that it'll only match Kernel then; try with e.g.

"""
[`Base.sin`](@ref)
"""
f(x) = x

but you're right that the search should handle something like Base.sin better (by searching for sin in Base), which would fix this "bug" as well.

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

No branches or pull requests

2 participants