Skip to content

Commit 1e1aa27

Browse files
committed
ai: Tags [ci skip]
1 parent fbf8c66 commit 1e1aa27

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ pak::pak(dependencies = "Config/Needs/build")
7171
### Documentation
7272

7373
- Use roxygen2 with Markdown syntax for all function documentation
74+
- Use explicit `@description` and `@details` sections, aim for a complete description and move only excess details to `@details`
7475
- Use math notation for formulas: `\eqn{...}` for inline, `\deqn{...}` for display equations
7576
- Keep each sentence on its own line in roxygen2 comments for better readability
7677
- Document all arguments and return values

0 commit comments

Comments
 (0)