Skip to content

DOC: Standardize noncompliant docstrings in pandas/io/html.py (flake8-docstrings) #61944

@gumus-g

Description

@gumus-g

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://github.com/pandas-dev/pandas/blob/main/pandas/io/html.py

Documentation problem

Several functions in pandas/io/html.py have docstrings that violate PEP 257 and pandas documentation guidelines. Flagged violations include:

  • D400: Docstring summary should end with a period
  • D205: Docstring summary should be followed by a blank line
  • D401: First line of docstring should be in imperative mood

These inconsistencies reduce clarity and hinder automated validation.

Suggested fix for documentation

Standardize docstring formatting based on flake8-docstrings and pydocstyle feedback to meet pandas’ documentation standards. This includes:

  • Adding missing punctuation and spacing
  • Rewriting summaries for clarity and imperative voice
  • Ensuring consistent style across the module

This fix is scoped to documentation and does not impact functionality.

Suggested labels: doc, refactor, good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsIO HTMLread_html, to_html, Styler.apply, Styler.applymap

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions