Skip to content

DOC: Minor typo fixes for code style guide #32379

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 1 commit into from
Mar 1, 2020
Merged
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions doc/source/development/code_style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Patterns
foo.__class__
-------------

*pandas* uses 'type(foo)' instead 'foo.__class__' as it is making the code more
*pandas* uses 'type(foo)' instead 'foo.__class__' as it makes the code more
readable.

For example:
Expand Down Expand Up @@ -52,8 +52,8 @@ f-strings

*pandas* uses f-strings formatting instead of '%' and '.format()' string formatters.

The convention of using f-strings on a string that is concatenated over serveral lines,
is to prefix only the lines containing the value needs to be interpeted.
The convention of using f-strings on a string that is concatenated over several lines,
is to prefix only the lines containing values which need to be interpreted.

For example:

Expand Down Expand Up @@ -86,8 +86,8 @@ For example:
White spaces
~~~~~~~~~~~~

Putting the white space only at the end of the previous line, so
there is no whitespace at the beggining of the concatenated string.
Only put white space at the end of the previous line, so
there is no whitespace at the beginning of the concatenated string.

For example:

Expand Down Expand Up @@ -116,7 +116,7 @@ Representation function (aka 'repr()')

*pandas* uses 'repr()' instead of '%r' and '!r'.

The use of 'repr()' will only happend when the value is not an obvious string.
The use of 'repr()' will only happen when the value is not an obvious string.

For example:

Expand All @@ -138,7 +138,7 @@ For example:
Imports (aim for absolute)
==========================

In Python 3, absolute imports are recommended. In absolute import doing something
In Python 3, absolute imports are recommended. Using absolute imports, 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 top-level pandas.
Expand Down