Skip to content

Commit 562150d

Browse files
author
Joe Cummings
committed
Fix lint
1 parent 40f3575 commit 562150d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ Each API and class should be clearly documented. Well-documented code is easier
5959
* All files under the [deep dives directory](docs/source/deep_dives) contain "deep-dive" tutorials
6060
* All files under the [tutorials directory](docs/source/tutorials) contain regular tutorials
6161

62-
Documentation is written in [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) format.
62+
Documentation is written in [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) format.
6363

6464
### Adding a new class/method to the API References
6565
Once you've added an API that is meant to be exposed publically, you should add it to the appropriate rst file. For example, any new API within the [configs/](torchtune/configs)
6666
directory should be added to `api_ref_configs.rst`, [data/](torchtune/data) should be added to `api_ref_data.rst`, [datasets](torchtune/datasets) should be added to
67-
`api_ref_datasets.rst`, and so on. To add, it's as simple as adding the name of the exposed API somewhere in the appropriate RST file.
67+
`api_ref_datasets.rst`, and so on. To add, it's as simple as adding the name of the exposed API somewhere in the appropriate RST file.
6868

69-
All code written within the docstring of the class or method will be correctly rendered there.
69+
All code written within the docstring of the class or method will be correctly rendered there.
7070

7171
> Note: Our RST theme expects code to be specified using double backticks instead of single. Eg: ``hidden_dim``. Single backticks will be rendered as italics instead of as "code".
7272

0 commit comments

Comments
 (0)