Skip to content

DOC: Fix style guide typos #31822

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.

Sign up for GitHub

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 3 commits into from
Feb 9, 2020
Merged

DOC: Fix style guide typos #31822

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4f5fdb
DOC: Fix style guide typos
Feb 9, 2020
c91f381
Is -> are
Feb 9, 2020
6122b6c
Edit spelling / grammar
Feb 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/source/development/code_style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,14 @@ For example:
.. code-block:: python

value = str
f"Unknown recived value, got: {repr(value)}"
f"Unknown received value, got: {repr(value)}"

**Good:**

.. code-block:: python

value = str
f"Unknown recived type, got: '{type(value).__name__}'"
f"Unknown received type, got: '{type(value).__name__}'"


Imports (aim for absolute)
Expand All @@ -135,11 +135,11 @@ Imports (aim for absolute)
In Python 3, absolute imports are recommended. In absolute import doing something
like ``import string`` will import the string module rather than ``string.py``
in the same directory. As much as possible, you should try to write out
absolute imports that show the whole import chain from toplevel pandas.
absolute imports that show the whole import chain from top-level pandas.

Explicit relative imports are also supported in Python 3. But it is not
recommended to use it. Implicit relative imports should never be used
and is removed in Python 3.
Explicit relative imports are also supported in Python 3 but it is not
recommended to use them. Implicit relative imports should never be used
and are removed in Python 3.

For example:

Expand Down