File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed
Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -25,3 +25,20 @@ Skills follow the [Agent Skills](https://agentskills.io) open standard. Each ski
2525
2626- ` SKILL.md ` — The skill definition with YAML frontmatter (name, description, argument-hint) and detailed instructions.
2727- Additional supporting files as needed.
28+
29+ ## Python Function Docstrings
30+
31+ Every Python function must include a docstring with usage examples.
32+
33+ - ** Examples are required** : Each function needs at least one doctest-style example
34+ demonstrating basic usage.
35+ - ** Optional parameters** : If a function has optional parameters, include separate
36+ examples that show usage both without and with the optional arguments. Pass
37+ optional arguments using their keyword name (e.g., ` step=dfn.lit(3) ` ) so readers
38+ can immediately see which parameter is being demonstrated.
39+ - ** Reuse input data** : Use the same input data across examples wherever possible.
40+ The examples should demonstrate how different optional arguments change the output
41+ for the same input, making the effect of each option easy to understand.
42+ - ** Alias functions** : Functions that are simple aliases (e.g., ` list_sort ` aliasing
43+ ` array_sort ` ) only need a one-line description and a ` See Also ` reference to the
44+ primary function. They do not need their own examples.
You can’t perform that action at this time.
0 commit comments