Skip to content

Update documenting.rst #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Update documenting.rst #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/how-to/documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ sections in your library's documentation:
- ``User guide``: Describes how to use basic features of the library.
- ``API reference`` Documents API resources provided by the library.
- ``Examples``: Provides fully fledged examples for using the library.
- ``Contributing``: Refers to the *PyAnsys developer's guide*
- ``Contribute``: Refers to the *PyAnsys developer's guide*
for overall guidance and then provides library-specific contribution information.

For comprehensive information on writing content, see :ref:`content_writing`.
Expand Down
Loading