Skip to content

Commit

Permalink
add barebones doc style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
axl1313 committed Jul 17, 2023
1 parent d077d5a commit 0f1159a
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,7 @@ Every time the version number is incremented, these parts of the codebase need t

1. `cleanlab_studio/version.py`
2. `README.md`

## Documentation Style Guide

cleanlab-studio uses [Google style](https://google.github.io/styleguide/pyguide.html#381-docstrings) docstrings ([example](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html))

0 comments on commit 0f1159a

Please sign in to comment.