The documentation for some of our functions is not in our standard format. See the examples in src/gcam/util.py for an illustration of how it should be done. The general format is
One-line description (one line, <80 char if possible)
Extended description (as many paragraphs as needed, may be omitted if there is nothing to add to the one-line description)
Arguments (see examples. Give sufficient detail for a user to figure out how to construct a correct set of arguments)
Return value (Give sufficient detail for a user to figure out how to use what the function returned)
Exceptions (Explain exceptions thrown; omit if none)
Bugs/Limitations (Note any surprising or problematic behavior or gotchas. Omit the section if none)
Modules and packages also need doc strings. For these the only relevant sections are (usually) the first two.
The documentation for some of our functions is not in our standard format. See the examples in
src/gcam/util.pyfor an illustration of how it should be done. The general format isModules and packages also need doc strings. For these the only relevant sections are (usually) the first two.