Skip to content

DOC: Styler errors PR08 and PR09 #28656

Closed
@HughKelley

Description

@HughKelley
python scripts/validate_docstrings.py pandas.io.formats.style.Styler --errors=PR08,PR09

Problem description

returns:

11 Errors found:
	Parameters {table_attributes} not documented
	Parameter "data" has no description
	Parameter "precision" description should start with a capital letter
	Parameter "precision" description should finish with "."
	Parameter "table_styles" description should start with a capital letter
	Parameter "table_styles" description should finish with "."
	Parameter "uuid" description should start with a capital letter
	Parameter "uuid" description should finish with "."
	Parameter "caption" description should start with a capital letter
	Parameter "caption" description should finish with "."
	Missing description for See Also "DataFrame.style" reference
2 Warnings found:
	No extended summary found
	No examples section found

This is a subset of error messages from #28602 and #25232. Part of the work for #27977

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