search

LLNL / sundials

Official development repository for SUNDIALS - a SUite of Nonlinear and DIfferential/ALgebraic equation Solvers. Pull requests are welcome for bug fixes and minor changes.
https://computing.llnl.gov/projects/sundials
BSD 3-Clause "New" or "Revised" License
520 stars 129 forks source link

Doc: Add Function Documentation Style Guide #588

Closed gardner48 closed 1 month ago

gardner48 commented 1 month ago

Some recent PRs have included comments about stylistic inconsistencies in the documentation. This PR adds a style guide for documenting user-callable and user-supplied functions to hopefully reduce this kind of traffic in future PRs.

gardner48 commented 1 month ago

Current PRs do not need to adopt this style but future additions to the docs should follow this guide. As time allows we can migrate existing documentation to this style.