8000 DOC: Adding guide for the pandas documentation sprint by datapythonista · Pull Request #19704 · pandas-dev/pandas · GitHub
[go: up one dir, main page]

Skip to content

DOC: Adding guide for the pandas documentation sprint #19704

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.

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 9 commits into from
Mar 12, 2018
Prev Previous commit
Next Next commit
removing note saying that examples are unit tests
  • Loading branch information
datapythonista committed Feb 25, 2018
commit 8e558b08c76878748a4f57f8b6b8c9d21bf0701e
6 changes: 3 additions & 3 deletions doc/source/contributing_docstring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -508,9 +508,9 @@ This is one of the most important sections of a docstring, even if it is
placed in the last position. As often, people understand concepts better
with examples, than with accurate explanations.

Examples in docstrings are also unit tests, and besides illustrating the
usage of the function or method, they need to be valid Python code, that in a
deterministic way returns the presented output.
Examples in docstrings, besides illustrating the usage of the function or
method, they must be valid Python code, that in a deterministic way returns
the presented output, and that can be copied and run by users.

They are presented as a session in the Python terminal. `>>>` is used to
present code. `...` is used for code continuing from the previous line.
Expand Down
0