pandas (original) (raw)

This should be the output for the docstrings edited so far in this PR.

to_string

3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found
Docstring for "pandas.core.series.Series.to_string" correct. :)

to_dict

2 Warnings found:
    No extended summary found
    See Also section not found
Docstring for "pandas.core.series.Series.to_dict" correct. :)

to_frame

3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found
Docstring for "pandas.core.series.Series.to_frame" correct. :)

to_sparse

(I think the first error is wrong here because "integer" is actually a string in the docstring. For this one I'm not familiar enough with the method to add a good description. Also, I think this will be deprecated soon anyways?)

2 Errors found:
    Parameter "kind" type should use "int" instead of "integer"
    Parameter "kind" has no description
3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found

count

3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found
Docstring for "pandas.core.series.Series.count" correct. :)

mode

2 Warnings found:
    See Also section not found
    No examples section found
Docstring for "pandas.core.series.Series.mode" correct. :)

drop_duplicates

(This is another one where the lowercase letter is an argument option.)

1 Errors found:
    Parameter "keep" description should start with a capital letter
1 Warnings found:
    No extended summary found

duplicated

(Same here.)

1 Errors found:
    Parameter "keep" description should start with a capital letter

idxmin

2 Errors found:
    Parameters {*args, **kwargs} not documented
    Unknown parameters {*args, **kwargs}

idxmax

2 Errors found:
    Parameters {*args, **kwargs} not documented
    Unknown parameters {*args, **kwargs}

round

1 Errors found:
    Parameters {**kwargs, *args} not documented
2 Warnings found:
    No extended summary found
    No examples section found

quantile

6 Errors found:
    Parameter "q" description should start with a capital letter
    Parameter "q" description should finish with "."
    Parameter "interpolation" has no description
    Return value description should start with a capital letter
    Missing description for See Also "core.window.Rolling.quantile" reference
    Missing description for See Also "numpy.percentile" reference

corr

6 Errors found:
    Parameter "other" has no description
    Parameter "method" description should start with a capital letter
    Parameter "method" description should finish with "."
    Parameter "min_periods" description should finish with "."
    Return value has no description
    flake8 error: E124 closing bracket does not match visual indentation
2 Warnings found:
    No extended summary found
    See Also section not found

cov

4 Errors found:
    Parameter "other" has no description
    Parameter "min_periods" description should finish with "."
    Return value has no description
    Return value has no description
3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found

diff

Docstring for "pandas.core.series.Series.diff" correct. :)

append

6 Errors found:
    Parameter "to_append" has no description
    Parameter "ignore_index" type should use "bool" instead of "boolean"
    Parameter "verify_integrity" type should use "bool" instead of "boolean"
    Parameter "verify_integrity" description should finish with "."
    Return value has no description
    flake8 error: E231 missing whitespace after ',' (2 times)
1 Warnings found:
    No extended summary found

sort_index

Docstring for "pandas.core.series.Series.sort_index" correct. :)

argsort

4 Errors found:
    Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
    Summary should fit in a single line
    Parameter "kind" description should finish with "."
    Missing description for See Also "numpy.ndarray.argsort" reference
1 Warnings found:
    No examples section found

swaplevel

4 Errors found:
    Parameters {j, copy, i} not documented
    Unknown parameters {i, j}
    Parameter "i, j" type should use "str" instead of "string"
    Return value has no description
3 Warnings found:
    No extended summary found
    See Also section not found
    No examples section found

unstack

7 Errors found:
    Summary should fit in a single line
    Parameter "level" type should use "str" instead of "string"
    Parameter "level" description should finish with "."
    Parameter "fill_value" description should start with a capital letter
    Parameter "fill_value" description should finish with "."
    Return value has no description
    flake8 error: E128 continuation line under-indented for visual indent
1 Warnings found:
    See Also section not found

rename

7 Errors found:
    Parameters {**kwargs} not documented
    Unknown parameters {level, inplace, copy}
    Parameter "index" description should start with a capital letter
    Parameter "copy" description should finish with "."
    Return value has no description
    Missing description for See Also "Series.rename_axis" reference
    flake8 error: E261 at least two spaces before inline comment

drop

4 Errors found:
    Parameters {columns, index} not documented
    Unknown parameters {index, columns}
    Return value has no description
    flake8 error: E231 missing whitespace after ',' (3 times)

isin

Docstring for "pandas.core.series.Series.isin" correct. :)

between

Docstring for "pandas.core.series.Series.between" correct. :)

from_csv

3 Errors found:
    Parameter "path" has no description
    Return value has no description
    Missing description for See Also "read_csv" reference
1 Warnings found:
    No examples section found

valid

2 Errors found:
    Parameters {inplace, **kwargs} not documented
    No Returns section found
2 Warnings found:
    See Also section not found
    No examples section found

to_period

2 Errors found:
    Summary should fit in a single line
    Parameters {copy} not documented
2 Warnings found:
    See Also section not found
    No examples section found