Skip to content

Commit

Permalink
Add guidance for docstrings when adding an API (#4981)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgerrits authored Jan 10, 2025
1 parent 001f026 commit 6044924
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,19 @@ Args:
agent_type (str): Agent type to handle this subscription
"""
```

## Docs when adding a new API

Now that 0.4.0 is out, we should ensure the docs between versions are easy to navigate. To this end, added or changed APIs should have the following added to their docstrings respectively:

```rst
.. versionadded:: v0.4.1
Here's a version added message.
.. versionchanged:: v0.4.1
Here's a version changed message.
```

See [here](https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/admonitions.html#versionadded) for how they are rendered.

0 comments on commit 6044924

Please sign in to comment.