Skip to content
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

DOC: Fix PR08 issues in docstrings in pandas.core.groupby #28706

Closed
dayoreke opened this issue Oct 1, 2019 · 3 comments
Closed

DOC: Fix PR08 issues in docstrings in pandas.core.groupby #28706

dayoreke opened this issue Oct 1, 2019 · 3 comments

Comments

@dayoreke
Copy link
Contributor

dayoreke commented Oct 1, 2019

Current errors:

$ ./scripts/validate_docstrings.py --errors=PR08
pandas.Series.corr: Parameter "method" description should start with a capital letter
pandas.Series.quantile: Parameter "q" description should start with a capital letter
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.rename: Parameter "index" description should start with a capital letter
pandas.Series.reorder_levels: Parameter "order" description should start with a capital letter
pandas.Series.dt.tz_localize: Parameter "errors" description should start with a capital letter
pandas.Series.str.match: Parameter "flags" description should start with a capital letter
pandas.Series.str.replace: Parameter "case" description should start with a capital letter
pandas.Series.str.replace: Parameter "flags" description should start with a capital letter
pandas.Series.str.replace: Parameter "regex" description should start with a capital letter
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.hist: Parameter "xrot" description should start with a capital letter
pandas.Series.hist: Parameter "yrot" description should start with a capital letter
pandas.Series.hist: Parameter "figsize" description should start with a capital letter
pandas.Timestamp.ceil: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.day_name: Parameter "locale" description should start with a capital letter
pandas.Timestamp.floor: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.fromordinal: Parameter "ordinal" description should start with a capital letter
pandas.Timestamp.month_name: Parameter "locale" description should start with a capital letter
pandas.Timestamp.round: Parameter "ambiguous" description should start with a capital letter
pandas.Timestamp.tz_localize: Parameter "errors" description should start with a capital letter
pandas.Period.to_timestamp: Parameter "how" description should start with a capital letter
pandas.arrays.IntervalArray.from_tuples: Parameter "copy" description should start with a capital letter
pandas.arrays.IntervalArray.from_breaks: Parameter "copy" description should start with a capital letter
pandas.read_msgpack: Parameter "iterator" description should start with a capital letter
pandas.io.json.build_table_schema: Parameter "primary_key" description should start with a capital letter
pandas.read_html: Parameter "skiprows" description should start with a capital letter
pandas.HDFStore.put: Parameter "format" description should start with a capital letter
pandas.HDFStore.append: Parameter "format" description should start with a capital letter
pandas.HDFStore.append: Parameter "append      " description should start with a capital letter
pandas.HDFStore.append: Parameter "dropna      " description should start with a capital letter
pandas.read_feather: Parameter "nthreads" description should start with a capital letter
pandas.read_feather: Parameter "use_threads" description should start with a capital letter
pandas.read_sql_table: Parameter "parse_dates" description should start with a capital letter
pandas.read_sql_query: Parameter "con" description should start with a capital letter
pandas.read_sql_query: Parameter "parse_dates" description should start with a capital letter
pandas.read_sql: Parameter "con" description should start with a capital letter
pandas.read_sql: Parameter "parse_dates" description should start with a capital letter
pandas.core.resample.Resampler.get_group: Parameter "name" description should start with a capital letter
pandas.core.resample.Resampler.get_group: Parameter "obj" description should start with a capital letter
pandas.core.resample.Resampler.pipe: Parameter "args" description should start with a capital letter
pandas.core.resample.Resampler.pipe: Parameter "kwargs" description should start with a capital letter
pandas.core.resample.Resampler.ffill: Parameter "limit" description should start with a capital letter
pandas.core.resample.Resampler.pad: Parameter "limit" description should start with a capital letter
pandas.core.resample.Resampler.sem: Parameter "ddof" description should start with a capital letter
pandas.core.resample.Resampler.var: Parameter "ddof" description should start with a capital letter
pandas.plotting.parallel_coordinates: Parameter "ax" description should start with a capital letter
pandas.plotting.scatter_matrix: Parameter "alpha" description should start with a capital letter
pandas.plotting.scatter_matrix: Parameter "figsize" description should start with a capital letter
pandas.plotting.scatter_matrix: Parameter "grid" description should start with a capital letter
pandas.plotting.scatter_matrix: Parameter "diagonal" description should start with a capital letter
pandas.plotting.scatter_matrix: Parameter "range_padding" description should start with a capital letter
pandas.plotting.table: Parameter "data" description should start with a capital letter
pandas.plotting.table: Parameter "kwargs" description should start with a capital letter
pandas.api.types.union_categoricals: Parameter "to_union" description should start with a capital letter
pandas.merge_ordered: Parameter "how" description should start with a capital letter
pandas.merge_asof: Parameter "allow_exact_matches" description should start with a capital letter
pandas.to_numeric: Parameter "errors" description should start with a capital letter
pandas.to_datetime: Parameter "arg" description should start with a capital letter
pandas.to_datetime: Parameter "errors" description should start with a capital letter
pandas.to_datetime: Parameter "box" description should start with a capital letter
pandas.to_datetime: Parameter "format" description should start with a capital letter
pandas.to_datetime: Parameter "exact" description should start with a capital letter
pandas.to_datetime: Parameter "unit" description should start with a capital letter
pandas.to_timedelta: Parameter "box" description should start with a capital letter
pandas.to_timedelta: Parameter "errors" description should start with a capital letter
pandas.infer_freq: Parameter "index" description should start with a capital letter
pandas.util.hash_array: Parameter "encoding" description should start with a capital letter
pandas.util.hash_pandas_object: Parameter "index" description should start with a capital letter
pandas.util.hash_pandas_object: Parameter "encoding" description should start with a capital letter
pandas.Index.drop_duplicates: Parameter "keep" description should start with a capital letter
pandas.Index.is_: Parameter "other" description should start with a capital letter
pandas.Index.fillna: Parameter "downcast" description should start with a capital letter
pandas.Index.to_series: Parameter "index" description should start with a capital letter
pandas.Index.to_series: Parameter "name" description should start with a capital letter
pandas.Index.get_indexer: Parameter "method" description should start with a capital letter
pandas.Index.get_loc: Parameter "method" description should start with a capital letter
pandas.CategoricalIndex.rename_categories: Parameter "new_categories" description should start with a capital letter
pandas.IntervalIndex.from_tuples: Parameter "copy" description should start with a capital letter
pandas.IntervalIndex.from_breaks: Parameter "copy" description should start with a capital letter
pandas.IntervalIndex.get_loc: Parameter "method" description should start with a capital letter
pandas.IntervalIndex.get_indexer: Parameter "method" description should start with a capital letter
pandas.MultiIndex.set_levels: Parameter "levels" description should start with a capital letter
pandas.MultiIndex.set_levels: Parameter "level" description should start with a capital letter
pandas.MultiIndex.set_levels: Parameter "inplace" description should start with a capital letter
pandas.MultiIndex.set_levels: Parameter "verify_integrity" description should start with a capital letter
pandas.MultiIndex.set_codes: Parameter "codes" description should start with a capital letter
pandas.MultiIndex.set_codes: Parameter "level" description should start with a capital letter
pandas.MultiIndex.set_codes: Parameter "inplace" description should start with a capital letter
pandas.MultiIndex.set_codes: Parameter "verify_integrity" description should start with a capital letter
pandas.MultiIndex.get_loc_level: Parameter "drop_level" description should start with a capital letter
pandas.MultiIndex.get_indexer: Parameter "method" description should start with a capital letter
pandas.MultiIndex.get_level_values: Parameter "level" description should start with a capital letter
pandas.DatetimeIndex.indexer_at_time: Parameter "time" description should start with a capital letter
pandas.DatetimeIndex.indexer_between_time: Parameter "start_time, end_time" description should start with a capital letter
pandas.DatetimeIndex.tz_localize: Parameter "errors" description should start with a capital letter
pandas.TimedeltaIndex.to_series: Parameter "index" description should start with a capital letter
pandas.TimedeltaIndex.to_series: Parameter "name" description should start with a capital letter
pandas.PeriodIndex.asfreq: Parameter "freq" description should start with a capital letter
pandas.PeriodIndex.asfreq: Parameter "how" description should start with a capital letter
pandas.core.window.rolling.Rolling.apply: Parameter "raw" description should start with a capital letter
pandas.core.window.expanding.Expanding.apply: Parameter "raw" description should start with a capital letter
pandas.core.groupby.GroupBy.get_group: Parameter "name" description should start with a capital letter
pandas.core.groupby.GroupBy.get_group: Parameter "obj" description should start with a capital letter
pandas.Grouper: Parameter "key" description should start with a capital letter
pandas.Grouper: Parameter "level" description should start with a capital letter
pandas.Grouper: Parameter "sort" description should start with a capital letter
pandas.core.groupby.GroupBy.pipe: Parameter "args" description should start with a capital letter
pandas.core.groupby.GroupBy.pipe: Parameter "kwargs" description should start with a capital letter
pandas.core.groupby.GroupBy.bfill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.GroupBy.ffill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.GroupBy.nth: Parameter "n" description should start with a capital letter
pandas.core.groupby.GroupBy.nth: Parameter "dropna" description should start with a capital letter
pandas.core.groupby.GroupBy.rank: Parameter "method" description should start with a capital letter
pandas.core.groupby.GroupBy.rank: Parameter "na_option" description should start with a capital letter
pandas.core.groupby.GroupBy.sem: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.GroupBy.std: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.GroupBy.var: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.bfill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.ffill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.filter: Parameter "dropna" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.rank: Parameter "method" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.rank: Parameter "na_option" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.shift: Parameter "periods" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.boxplot: Parameter "subplots" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.boxplot: Parameter "layout" description should start with a capital letter
pandas.io.formats.style.Styler: Parameter "precision" description should start with a capital letter
pandas.io.formats.style.Styler: Parameter "table_styles" description should start with a capital letter
pandas.io.formats.style.Styler: Parameter "uuid" description should start with a capital letter
pandas.io.formats.style.Styler: Parameter "caption" description should start with a capital letter
pandas.io.formats.style.Styler.apply: Parameter "func" description should start with a capital letter
pandas.io.formats.style.Styler.apply: Parameter "axis" description should start with a capital letter
pandas.io.formats.style.Styler.apply: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.apply: Parameter "**kwargs" description should start with a capital letter
pandas.io.formats.style.Styler.applymap: Parameter "func" description should start with a capital letter
pandas.io.formats.style.Styler.applymap: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.applymap: Parameter "**kwargs" description should start with a capital letter
pandas.io.formats.style.Styler.where: Parameter "cond" description should start with a capital letter
pandas.io.formats.style.Styler.where: Parameter "value" description should start with a capital letter
pandas.io.formats.style.Styler.where: Parameter "other" description should start with a capital letter
pandas.io.formats.style.Styler.where: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.where: Parameter "**kwargs" description should start with a capital letter
pandas.io.formats.style.Styler.set_properties: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.set_properties: Parameter "**kwargs" description should start with a capital letter
pandas.io.formats.style.Styler.highlight_max: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.highlight_max: Parameter "axis" description should start with a capital letter
pandas.io.formats.style.Styler.highlight_min: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.highlight_min: Parameter "axis" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "cmap" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "low" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "high" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "axis" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "subset" description should start with a capital letter
pandas.io.formats.style.Styler.background_gradient: Parameter "text_color_threshold" description should start with a capital letter
pandas.io.formats.style.Styler.bar: Parameter "axis" description should start with a capital letter
pandas.io.formats.style.Styler.use: Parameter "styles" description should start with a capital letter
pandas.api.extensions.ExtensionArray.argsort: Parameter "*args, **kwargs:" description should start with a capital letter
pandas.DataFrame.insert: Parameter "column" description should start with a capital letter

This is a subset of #27977

@dayoreke
Copy link
Contributor Author

dayoreke commented Oct 1, 2019

I will be working on

pandas.core.groupby.GroupBy.pipe: Parameter "args" description should start with a capital letter
pandas.core.groupby.GroupBy.pipe: Parameter "kwargs" description should start with a capital letter
pandas.core.groupby.GroupBy.bfill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.GroupBy.ffill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.GroupBy.nth: Parameter "n" description should start with a capital letter
pandas.core.groupby.GroupBy.nth: Parameter "dropna" description should start with a capital letter
pandas.core.groupby.GroupBy.rank: Parameter "method" description should start with a capital letter
pandas.core.groupby.GroupBy.rank: Parameter "na_option" description should start with a capital letter
pandas.core.groupby.GroupBy.sem: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.GroupBy.std: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.GroupBy.var: Parameter "ddof" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.bfill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.ffill: Parameter "limit" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.filter: Parameter "dropna" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.rank: Parameter "method" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.rank: Parameter "na_option" description should start with a capital letter
pandas.core.groupby.DataFrameGroupBy.shift: Parameter "periods" description should start with a capital letter

@anirudnits
Copy link
Contributor

I would like to work on this.

@simonjayhawkins
Copy link
Member

Thanks @dayoreke . I believe this is the same as #25232.

Feel free to work on pieces of it at a time, and reference that issue in each PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants