Skip to content

Commit

Permalink
fix: updated the google docstring url (#2967)
Browse files Browse the repository at this point in the history
  • Loading branch information
kachida committed Mar 3, 2024
1 parent 48f8293 commit 9dcf733
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ Documentation is hosted at `Read the Docs
rebuilding it after every commit.

For docstrings, we use `the Google docstring format
<https://www.sphinx-doc.org/en/3.x/usage/extensions/example_google.html#example-google-style-python-docstrings>`__.
<https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google-style-python-docstrings>`__.
If you add a new function or class, there's no mechanism for
automatically adding that to the docs: you'll have to at least add a
line like ``.. autofunction:: <your function>`` in the appropriate
Expand Down

0 comments on commit 9dcf733

Please sign in to comment.