@@ -5,12 +5,12 @@ OpenNMT-py is a community developed project and we love developer contributions.
55## Guidelines
66Before sending a PR, please do this checklist first:
77
8- - Please run ` tools /pull_request_chk.sh` and fix any errors. When adding new functionality, also add tests to this script. Included checks:
8+ - Please run ` onmt/tests /pull_request_chk.sh` and fix any errors. When adding new functionality, also add tests to this script. Included checks:
99 1 . flake8 check for coding style;
1010 2 . unittest;
1111 3 . continuous integration tests listed in ` .travis.yml ` .
1212- When adding/modifying class constructor, please make the arguments as same naming style as its superclass in PyTorch.
13- - If your change is based on a paper, please include a clear comment and reference in the code (more on that below).
13+ - If your change is based on a paper, please include a clear comment and reference in the code (more on that below).
1414
1515### Docstrings
1616Above all, try to follow the Google docstring format
@@ -40,19 +40,19 @@ For multiple returns, the following works well with Sphinx and is still very rea
4040 ``` python
4141 def foo (a , b ):
4242 """ This is my docstring.
43-
43+
4444 Args:
4545 a (object): Something.
4646 b (class): Another thing.
47-
47+
4848 Returns:
4949 (object, class):
50-
50+
5151 * a: Something or rather with a long
5252 description that spills over.
5353 * b: And another thing.
5454 """
55-
55+
5656 return a, b
5757 ```
5858- When citing a paper, avoid directly linking in the docstring! Add a Bibtex entry to ` docs/source/refs.bib ` .
@@ -67,12 +67,12 @@ citation into `refs.bib`. Then, in your docstring, use ``:cite:`DBLP:journals/co
6767 the parentheses format with single ticks).
6868 - Again, a different style is better than no shape documentation.
6969- Please avoid unnecessary space characters, try to capitalize, and try to punctuate.
70-
70+
7171 For multi-line docstrings, add a blank line after the closing `` """ `` .
7272 Don't use a blank line before the closing quotes.
73-
73+
7474 `` """ not this """ `` `` """This.""" ``
75-
75+
7676 ``` python
7777 """
7878 Not this.
@@ -85,4 +85,4 @@ citation into `refs.bib`. Then, in your docstring, use ``:cite:`DBLP:journals/co
8585 This note is the least important. Focus on content first, but remember that consistent docs look good.
8686- Be sensible about the first line. Generally, one stand-alone summary line (per the Google guidelines) is good.
8787 Sometimes, it's better to cut directly to the args or an extended description. It's always acceptable to have a
88- "trailing" citation.
88+ "trailing" citation.
0 commit comments