trixi-framework / trixi-framework/Trixi.jl

Use `# Extended help` sections where useful/helpful/applicable

Open
#1,306 0 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
731
Forks
166
Avg merge
2d 18h
Merged PRs (30d)
25

Description

I just came across the feature of docstrings that allows one to access an *extended help* from the REPL help mode. This works such that if you add a section labelled `# Extended help` in your docstring, it is hidden by default when you query the help, e.g., by typing `?trixi_include`. In lieu of that section, it will just show a hint to the user
```
Extended help is available with `??`
```
If one instead types `??trixi_include` in the REPL, the original docstring + the extended help section is shown.

I do not have a specific use case, I just wanted to bring this to attention since it might allow us to (re-)structure longish docstrings in the future.

**EDIT**: [Here](https://docs.julialang.org/en/v1/manual/documentation/#Writing-Documentation) is the relevant part of the Julia docs, see point 11.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.