···213213This makes reviews and suggestions much easier, since GitHub's review system is based on lines.
214214It also helps identifying long sentences at a glance.
215215216216+### Writing Function Documentation
217217+218218+Function documentation is *reference documentation*, for which
219219+[diataxis Reference documentation](https://diataxis.fr/reference/) (8 minutes) is **mandatory reading**.
220220+221221+On top of the diataxis framework, which provides a balanced perspective on what reference documentation should contain, we apply a specific style rule to function documentation:
222222+the first sentence is in present tense, active voice, and the subject is omitted, referring implicitly to the name of the function.
223223+For example:
224224+225225+```nix
226226+/**
227227+ Subtracts value `b` from value `a`.
228228+229229+ Returns the difference as a number.
230230+*/
231231+subtractValues # ...elided code
232232+```
233233+234234+Renders as:
235235+236236+```md
237237+## `subtractValues`
238238+239239+Subtracts value `b` from value `a`.
240240+241241+Returns the difference as a number.
242242+```
243243+216244### Callouts and examples
217245218246Use the [admonition syntax](#admonitions) for callouts and examples.