Merge branch 'master' into flake8-fix-ignored-errors

pytorch · Feb 1, 2021 · 514b8f4 · 514b8f4
2 parents 81fef89 + 07da5ea
commit 514b8f4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/.github/workflows/code-style.yml b/.github/workflows/code-style.yml
@@ -22,7 +22,7 @@ jobs:
   code-style:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
           python-version: "3.8"

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -203,7 +203,17 @@ git merge upstream/master
 ### Writing documentation
 
 Ignite uses [Google style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
-for formatting docstrings. Length of line inside docstrings block must be limited to 120 characters.
+for formatting docstrings and
+
+- [`.. versionadded::`] directive for adding new classes, class methods, functions,
+- [`.. versionchanged::`] directive for adding new arguments, changing internal behaviours, fixing bugs and
+- [`.. deprecated::`] directive for deprecations.
+
+Length of line inside docstrings block must be limited to 120 characters.
+
+[`.. versionadded::`]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
+[`.. versionchanged::`]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged
+[`.. deprecated::`]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated
 
 #### Local documentation building and deploying