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

Mention help?> "string" in the docstring for apropos #42732

Closed
Seelengrab opened this issue Oct 21, 2021 · 0 comments · Fixed by #42748
Closed

Mention help?> "string" in the docstring for apropos #42732

Seelengrab opened this issue Oct 21, 2021 · 0 comments · Fixed by #42748
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia

Comments

@Seelengrab
Copy link
Contributor

The docstring for apropos could mention the shorthand help?> "string" version as well, I use apropos all the time but just learned about this shorthand <3

Originally posted by @baggepinnen in #37523 (comment)

This would be a good first doc issue - the definition for apropos and its docstring can be found here:

"""
apropos([io::IO=stdout], pattern::Union{AbstractString,Regex})
Search available docstrings for entries containing `pattern`.
When `pattern` is a string, case is ignored. Results are printed to `io`.
"""
apropos(string) = apropos(stdout, string)
apropos(io::IO, string) = apropos(io, Regex("\\Q$string", "i"))

@fredrikekre fredrikekre added domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia labels Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants