Skip to content

DOC: Fixing docstrings formatting error PR08, PR09 in pandas.Series #28738

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

Jump to bottom
Closed
jb8429 opened this issue Oct 1, 2019 · 1 comment
Closed

DOC: Fixing docstrings formatting error PR08, PR09 in pandas.Series #28738

jb8429 opened this issue Oct 1, 2019 · 1 comment
Labels
Docs

Comments

@jb8429
Copy link
Contributor

jb8429 commented Oct 1, 2019

This is a subset of:

  • #28602 the PR09 issue overview,
  • #25232 the PR08 issue overview,
  • #27977 the overall docstring error overview

Fixing PR08 and PR09 errors in pandas.Series:

pandas.Series.to_numpy: Parameter "dtype" description should finish with "."
pandas.Series.corr: Parameter "method" description should start with a capital letter
pandas.Series.corr: Parameter "method" description should finish with "."
pandas.Series.quantile: Parameter "q" description should start with a capital letter
pandas.Series.rank: Parameter "method" description should finish with "."
pandas.Series.rank: Parameter "na_option" description should finish with "."
pandas.Series.sem: Parameter "skipna" description should finish with "."
pandas.Series.sem: Parameter "level" description should finish with "."
pandas.Series.std: Parameter "skipna" description should finish with "."
pandas.Series.std: Parameter "level" description should finish with "."
pandas.Series.var: Parameter "skipna" description should finish with "."
pandas.Series.var: Parameter "level" description should finish with "."
pandas.Series.align: Parameter "axis" description should finish with "."
pandas.Series.align: Parameter "level" description should finish with "."
pandas.Series.align: Parameter "fill_value" description should finish with "."
pandas.Series.align: Parameter "method" description should finish with "."
pandas.Series.align: Parameter "fill_axis" description should finish with "."
pandas.Series.align: Parameter "broadcast_axis" description should finish with "."
pandas.Series.drop_duplicates: Parameter "keep" description should start with a capital letter
pandas.Series.duplicated: Parameter "keep" description should start with a capital letter
pandas.Series.reindex: Parameter "index" description should finish with "."
pandas.Series.reindex: Parameter "method" description should finish with "."
pandas.Series.reindex_like: Parameter "method" description should finish with "."
pandas.Series.rename: Parameter "index" description should start with a capital letter
pandas.Series.argsort: Parameter "kind" description should finish with "."
pandas.Series.reorder_levels: Parameter "order" description should start with a capital letter
pandas.Series.reorder_levels: Parameter "order" description should finish with "."
pandas.Series.asfreq: Parameter "method" description should finish with "."
pandas.Series.asfreq: Parameter "how" description should finish with "."
pandas.Series.asfreq: Parameter "normalize" description should finish with "."
pandas.Series.tz_localize: Parameter "level" description should finish with "."
pandas.Series.tz_localize: Parameter "copy" description should finish with "."
pandas.Series.tz_localize: Parameter "ambiguous" description should finish with "."
pandas.Series.tz_localize: Parameter "nonexistent" description should finish with "."
pandas.Series.tshift: Parameter "periods" description should finish with "."
pandas.Series.tshift: Parameter "freq" description should finish with "."
pandas.Series.tshift: Parameter "axis" description should finish with "."
pandas.Series.slice_shift: Parameter "periods" description should finish with "."
pandas.Series.dt.tz_localize: Parameter "ambiguous" description should finish with "."
pandas.Series.dt.tz_localize: Parameter "nonexistent" description should finish with "."
pandas.Series.dt.tz_localize: Parameter "errors" description should start with a capital letter
pandas.Series.dt.round: Parameter "ambiguous" description should finish with "."
pandas.Series.dt.round: Parameter "nonexistent" description should finish with "."
pandas.Series.dt.floor: Parameter "ambiguous" description should finish with "."
pandas.Series.dt.floor: Parameter "nonexistent" description should finish with "."
pandas.Series.dt.ceil: Parameter "ambiguous" description should finish with "."
pandas.Series.dt.ceil: Parameter "nonexistent" description should finish with "."
pandas.Series.str.center: Parameter "width" description should finish with "."
pandas.Series.str.center: Parameter "fillchar" description should finish with "."
pandas.Series.str.find: Parameter "sub" description should finish with "."
pandas.Series.str.find: Parameter "start" description should finish with "."
pandas.Series.str.find: Parameter "end" description should finish with "."
pandas.Series.str.index: Parameter "sub" description should finish with "."
pandas.Series.str.index: Parameter "start" description should finish with "."
pandas.Series.str.index: Parameter "end" description should finish with "."
pandas.Series.str.ljust: Parameter "width" description should finish with "."
pandas.Series.str.ljust: Parameter "fillchar" description should finish with "."
pandas.Series.str.match: Parameter "flags" description should start with a capital letter
pandas.Series.str.normalize: Parameter "form" description should finish with "."
pandas.Series.str.replace: Parameter "case" description should start with a capital letter
pandas.Series.str.replace: Parameter "case" description should finish with "."
pandas.Series.str.replace: Parameter "flags" description should start with a capital letter
pandas.Series.str.replace: Parameter "flags" description should finish with "."
pandas.Series.str.replace: Parameter "regex" description should start with a capital letter
pandas.Series.str.rfind: Parameter "sub" description should finish with "."
pandas.Series.str.rfind: Parameter "start" description should finish with "."
pandas.Series.str.rfind: Parameter "end" description should finish with "."
pandas.Series.str.rindex: Parameter "sub" description should finish with "."
pandas.Series.str.rindex: Parameter "start" description should finish with "."
pandas.Series.str.rindex: Parameter "end" description should finish with "."
pandas.Series.str.rjust: Parameter "width" description should finish with "."
pandas.Series.str.rjust: Parameter "fillchar" description should finish with "."
pandas.Series.str.translate: Parameter "table" description should start with a capital letter
pandas.Series.cat.rename_categories: Parameter "new_categories" description should start with a capital letter
pandas.Series.cat.rename_categories: Parameter "new_categories" description should finish with "."
pandas.Series.plot: Parameter "data" description should finish with "."
pandas.Series.plot: Parameter "kind" description should finish with "."
pandas.Series.plot: Parameter "use_index" description should finish with "."
pandas.Series.plot: Parameter "grid" description should finish with "."
pandas.Series.plot: Parameter "legend" description should finish with "."
pandas.Series.plot: Parameter "style" description should finish with "."
pandas.Series.plot: Parameter "logx" description should finish with "."
pandas.Series.plot: Parameter "logy" description should finish with "."
pandas.Series.plot: Parameter "loglog" description should finish with "."
pandas.Series.plot: Parameter "rot" description should finish with "."
pandas.Series.plot: Parameter "colorbar" description should finish with "."
pandas.Series.plot: Parameter "position" description should finish with "."
pandas.Series.plot: Parameter "mark_right" description should finish with "."
pandas.Series.hist: Parameter "by" description should finish with "."
pandas.Series.hist: Parameter "ax" description should finish with "."
pandas.Series.hist: Parameter "grid" description should finish with "."
pandas.Series.hist: Parameter "xlabelsize" description should finish with "."
pandas.Series.hist: Parameter "xrot" description should start with a capital letter
pandas.Series.hist: Parameter "xrot" description should finish with "."
pandas.Series.hist: Parameter "ylabelsize" description should finish with "."
pandas.Series.hist: Parameter "yrot" description should start with a capital letter
pandas.Series.hist: Parameter "yrot" description should finish with "."
pandas.Series.hist: Parameter "figsize" description should start with a capital letter
pandas.Series.hist: Parameter "figsize" description should finish with "."
pandas.Series.hist: Parameter "**kwargs" description should finish with "."
pandas.Series.to_pickle: Parameter "protocol" description should finish with "."
pandas.Series.to_msgpack: Parameter "path" description should finish with "."
pandas.Series.to_json: Parameter "orient" description should finish with "."
This was referenced Oct 1, 2019
Closed
Merged
@simonjayhawkins
Copy link
Member

closed in #28845

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@simonjayhawkins @jb8429