Skip to content

Commit

Permalink
add instructions for creating docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Titus-von-Koeller committed Feb 4, 2024
1 parent d3709f4 commit e00cbc9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/source/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Now all the pre-commit hooks will be automatically run when you try to commit an

## Doc-string syntax

TODO: Add description + reference of HF docstring best practices.
We're following NumPy doc-string conventions with the only notable difference being that we use Markdown instead of Rich text format (RTF) for markup within the doc-strings.

Please see the existing documentation to see how to generate autodocs.

## Documentation
- [guideline for documentation syntax](https://github.com/huggingface/doc-builder#readme)
Expand Down

0 comments on commit e00cbc9

Please sign in to comment.