Skip to content

DOC: Fixing docstring formatting errors in PR08, PR09 in pandas.io #28747

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

Closed
dayoreke opened this issue Oct 2, 2019 · 2 comments · Fixed by #28748
Closed

DOC: Fixing docstring formatting errors in PR08, PR09 in pandas.io #28747

dayoreke opened this issue Oct 2, 2019 · 2 comments · Fixed by #28748
Labels
Milestone

Comments

@dayoreke
Copy link
Contributor

dayoreke commented Oct 2, 2019

Fixing PR08, PR09 errors in pandas.io:

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
@dayoreke
Copy link
Contributor Author

dayoreke commented Oct 2, 2019

Fixing this also

pandas.io.formats.style.Styler.from_custom_template: Parameter "searchpath" description should finish with "."
pandas.io.formats.style.Styler.from_custom_template: Parameter "name" description should finish with "."
pandas.io.formats.style.Styler.apply: Parameter "func" description should finish with "."
pandas.io.formats.style.Styler.apply: Parameter "subset" description should finish with "."
pandas.io.formats.style.Styler.apply: Parameter "**kwargs" description should finish with "."
pandas.io.formats.style.Styler.applymap: Parameter "func" description should finish with "."
pandas.io.formats.style.Styler.applymap: Parameter "subset" description should finish with "."
pandas.io.formats.style.Styler.applymap: Parameter "**kwargs" description should finish with "."
pandas.io.formats.style.Styler.where: Parameter "cond" description should finish with "."
pandas.io.formats.style.Styler.where: Parameter "value" description should finish with "."
pandas.io.formats.style.Styler.where: Parameter "other" description should finish with "."
pandas.io.formats.style.Styler.where: Parameter "subset" description should finish with "."
pandas.io.formats.style.Styler.where: Parameter "**kwargs" description should finish with "."
pandas.io.formats.style.Styler.set_properties: Parameter "subset" description should finish with "."
pandas.io.formats.style.Styler.set_properties: Parameter "**kwargs" description should finish with "."
pandas.io.formats.style.Styler.background_gradient: Parameter "cmap" description should finish with "."
pandas.io.formats.style.Styler.bar: Parameter "align" description should finish with "."
pandas.io.formats.style.Styler.use: Parameter "styles" description should finish with "."

@HughKelley
Copy link
Contributor

HughKelley commented Oct 18, 2019

Hi just working through the remaining PR09 errors sequentially.

It looks like PR #28748 didn't catch:
pandas.io.formats.style.Styler.bar: Parameter "align" description should finish with "."

edit: actually, looking more closely, align is formatted the same as several other parameters, vmin for instance. But validate_docstrings.py only throws errors for align. Maybe something to do with the start of the extra linebreaks?

Thanks! @simonjayhawkins @dayoreke

    """
    Draw bar chart in the cell backgrounds.

    Parameters
    ----------
    subset : IndexSlice, optional
        A valid slice for `data` to limit the style application to.
    axis : {0 or 'index', 1 or 'columns', None}, default 0
        Apply to each column (``axis=0`` or ``'index'``), to each row
        (``axis=1`` or ``'columns'``), or to the entire DataFrame at once
        with ``axis=None``.
    color : str or 2-tuple/list
        If a str is passed, the color is the same for both
        negative and positive numbers. If 2-tuple/list is used, the
        first element is the color_negative and the second is the
        color_positive (eg: ['#d65f5f', '#5fba7d']).
    width : float, default 100
        A number between 0 or 100. The largest value will cover `width`
        percent of the cell's width.
    align : {'left', 'zero',' mid'}, default 'left'
        How to align the bars with the cells.

        - 'left' : the min value starts at the left of the cell.
        - 'zero' : a value of zero is located at the center of the cell.
        - 'mid' : the center of the cell is at (max-min)/2, or
          if values are all negative (positive) the zero is aligned
          at the right (left) of the cell.

          .. versionadded:: 0.20.0

    vmin : float, optional
        Minimum bar value, defining the left hand limit
        of the bar drawing range, lower values are clipped to `vmin`.
        When None (default): the minimum value of the data will be used.

        .. versionadded:: 0.24.0

    vmax : float, optional
        Maximum bar value, defining the right hand limit
        of the bar drawing range, higher values are clipped to `vmax`.
        When None (default): the maximum value of the data will be used.

        .. versionadded:: 0.24.0

    Returns
    -------
    self : Styler
    """

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

Successfully merging a pull request may close this issue.

3 participants