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

Include function signatures, arguments and keywords in docs #12

Open
rafaqz opened this issue Sep 15, 2024 · 0 comments
Open

Include function signatures, arguments and keywords in docs #12

rafaqz opened this issue Sep 15, 2024 · 0 comments

Comments

@rafaqz
Copy link

rafaqz commented Sep 15, 2024

I was just trying to learn what functions are available in this package from the REPL, but its pretty hard to do.

Its common to include a method signature at the top of Julia docs.
Then its nice to list arguments and keywords describing what they do.

Something like this:

"""
    species_citation(name::String, [region::String]; kw...)

Species citations bla bla

# Arguments

- `name`: name of the foo
- `region`: region for the bar

# Keywords
...
"""

The square bracket is for optional arguments

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

No branches or pull requests

1 participant