Skip to content

Fix PR02 in docstrings #162

@WuraolaOyewusi

Description

@WuraolaOyewusi

@datapythonista . I'll like to attempt some of these in pandas

For the *args, **kwargs Unknown parameters. I guess it's because they are on the same line or that : is written after **kwargs

I noticed many of the error docstrings errors such as pandas.Series.str.slice_replace: Unknown parameters {stop, repl, start} flags the parameters as Unknown parameters.

def str_slice_replace(arr, start=None, stop=None, repl=None):
"""
Replace a positional slice of a string with another value.
Parameters
----------
start : int, optional
Left index position to use for the slice. If not specified (None),
the slice is unbounded on the left, i.e. slice from the start
of the string.
stop : int, optional
Right index position to use for the slice. If not specified (None),
the slice is unbounded on the right, i.e. slice until the
end of the string.
repl : str, optional
String for replacement. If not specified (None), the sliced region
is replaced with an empty string.

I'm wondering if something changed in the writing convention of pandas docstrings.

I read the pandas docstring guide. I haven't found the answer there.

Please can you prompt on what I should look out for?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions