Skip to content

Add missing spacing before or after a param name in docstrings #23738

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 2 commits into from
Nov 17, 2018
Merged

Add missing spacing before or after a param name in docstrings #23738

merged 2 commits into from
Nov 17, 2018

Conversation

srinivasreddy
Copy link
Contributor

@srinivasreddy srinivasreddy commented Nov 16, 2018

@pep8speaks
Copy link

pep8speaks commented Nov 16, 2018

Hello @srinivasreddy! Thanks for updating the PR.

Comment last updated on November 17, 2018 at 04:33 Hours UTC

@codecov
Copy link

codecov bot commented Nov 16, 2018

Codecov Report

Merging #23738 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #23738   +/-   ##
=======================================
  Coverage   92.25%   92.25%           
=======================================
  Files         161      161           
  Lines       51390    51390           
=======================================
  Hits        47411    47411           
  Misses       3979     3979
Flag Coverage Δ
#multiple 90.64% <ø> (ø) ⬆️
#single 42.31% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/io/feather_format.py 89.74% <ø> (ø) ⬆️
pandas/io/formats/style.py 96.69% <ø> (ø) ⬆️
pandas/compat/pickle_compat.py 75.6% <ø> (ø) ⬆️
pandas/core/series.py 93.68% <ø> (ø) ⬆️
pandas/core/resample.py 96.99% <ø> (ø) ⬆️
pandas/core/frame.py 97.02% <ø> (ø) ⬆️
pandas/plotting/_tools.py 78.77% <ø> (ø) ⬆️
pandas/core/algorithms.py 95.11% <ø> (ø) ⬆️
pandas/plotting/_core.py 83.63% <ø> (ø) ⬆️
pandas/io/packers.py 88.08% <ø> (ø) ⬆️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db2066b...f4519fa. Read the comment docs.

@srinivasreddy
Copy link
Contributor Author

srinivasreddy commented Nov 16, 2018

The remaining are,

pandas.ExcelWriter: Parameter ".. versionadded" requires a space before the colon separating the parameter name and type
pandas.core.groupby.DataFrameGroupBy.boxplot: Parameter "subplots " requires a space before the colon separating the parameter name and type
pandas.set_option: Parameter "value " requires a space before the colon separating the parameter name and type

@gfyoung gfyoung added Docs Code Style Code style, linting, code_checks labels Nov 16, 2018
@srinivasreddy
Copy link
Contributor Author

@gfyoung The remaining cannot be done as fixing them introduce trailing spaces.

@jreback jreback added this to the 0.24.0 milestone Nov 17, 2018
@jreback jreback merged commit 1a42c70 into pandas-dev:master Nov 17, 2018
@jreback
Copy link
Contributor

jreback commented Nov 17, 2018

thanks @srinivasreddy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Style Code style, linting, code_checks Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Fix formatting of parameters
4 participants