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.

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

Attempt to follow the Julia docstring conventions #466

Merged
merged 1 commit into from
Jan 27, 2024
Merged

Attempt to follow the Julia docstring conventions #466

merged 1 commit into from
Jan 27, 2024

Commits on Jan 21, 2024

  1. Attempt to follow the Julia docstring conventions 

    In particular, the docs recommends `# Arguments` instead of `### Parameters`:
https://docs.julialang.org/en/v1/manual/documentation/#Writing-Documentation

They also use a single '#' for other section headings, though in practice
Documenter.jl seems to render them exactly the same anyway.
    @JamesWrigley
    JamesWrigley committed Jan 21, 2024
    Configuration menu
    Copy the full SHA
    f76eccd View commit details
    Browse the repository at this point in the history