Skip to content

Commit

Permalink
README-documentation-rules.md: Mention not listing types in param/ret…
Browse files Browse the repository at this point in the history
…urns docs.
  • Loading branch information
icculus committed Nov 21, 2024
1 parent fef001c commit a0591ec
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/README-documentation-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,15 @@ wikiheaders will complain loudly if you don't do this, and exit with an
error message.


## Don't repeat type names in `\param` and `\returns` sections.

Wikiheaders will explicitly mention the datatype for each parameter and the
return value, linking to the datatype's wikipage. Users reading the headers
can see the types in the function signature right below the documentation
comment. So don't mention the type a second time in the documentation if
possible. It looks cluttered and repetitive to do so.


## Code examples go in the wiki.

We don't want the headers cluttered up with code examples. These live on the
Expand Down

0 comments on commit a0591ec

Please sign in to comment.