docs: backtick parameter references in API comments
This commit is contained in:
@@ -58,6 +58,7 @@ while (
|
||||
|
||||
- prefer lowercase prose in documentation, including headings and sentence starts. preserve the case of code identifiers, proper names, and acronyms.
|
||||
- write comments for invariants, ownership, or reasons that the code alone does not explain. use `#!` for API documentation.
|
||||
- enclose explicit references to parameter identifiers in backticks, for example: “an empty `destination` is a no-op.” leave general conceptual terms unquoted, even when they match a parameter name, for example: “memory must be freed with the same allocator that was used to allocate it.”
|
||||
- when editing a function, review its existing comments and API documentation against the resulting implementation. update comments that remain useful; remove those that are obsolete or merely restate self-explanatory code. retain contracts and rationale that callers or maintainers cannot infer from the implementation.
|
||||
|
||||
## library operations
|
||||
|
||||
Reference in New Issue
Block a user