alihan/textattack-nlp-transformer
1
0
Fork 0
mirror of https://github.com/QData/TextAttack.git synced 2021-10-13 00:05:06 +03:00
Code Issues Projects Releases Wiki Activity

Clarify CONTRIBUTING.md

Browse Source
This commit is contained in:
Eli Lifland
2020-08-31 21:45:26 -04:00
committed by GitHub
parent c9931daf43
commit 0ece7ca4e9
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -181,11 +181,11 @@ Follow these steps to start contributing:
6. Add documentation.
Our docs are in the `docs/` folder. Thanks to `sphinx-automodule`, this
should just be two lines. Our docs will automatically generate from the
comments you added to your code. If you're adding an attack recipe, add a
reference in `attack_recipes.rst`. If you're adding a transformation, add
a reference in `transformation.rst`, etc.
Our docs are in the `docs/` folder. Thanks to `sphinx-automodule`, adding
documentation for a new code file should just be two lines. Our docs will
automatically generate from the comments you added to your code. If you're
adding an attack recipe, add a reference in `attack_recipes.rst`.
If you're adding a transformation, add a reference in `transformation.rst`, etc.
You can build the docs and view the updates using `make docs`. If you're
adding a tutorial or something where you want to update the docs multiple