We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent fbf8c66 commit 1e1aa27Copy full SHA for 1e1aa27
AGENTS.md
@@ -71,6 +71,7 @@ pak::pak(dependencies = "Config/Needs/build")
71
### Documentation
72
73
- 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`
75
- Use math notation for formulas: `\eqn{...}` for inline, `\deqn{...}` for display equations
76
- Keep each sentence on its own line in roxygen2 comments for better readability
77
- Document all arguments and return values
0 commit comments