google / google/styleguide

Inconsistent indentation suggestions for Python

Open
#417 4 comments 0 reactions 1 assignee Claimed by @gpshead View on GitHub
lang:python
Dominant language
HTML
Stars
39.6k
Forks
12.9k
Avg merge
42m
Merged PRs (30d)
15

Description

The Python style guide for docstrings gives inconsistent advice for indentation. It initially says,

> Sections should be indented two spaces, except for the heading

Yet all of the examples feature four spaces of indentation. Further, under the *Args* section, it says,

> If the description is too long to fit on a single 80-character line, use a hanging indent of 2 or 4 spaces (be consistent with the rest of the file).

Probably the first quote should read "Sections should be indented two or four spaces (be consistent with the rest of the file), except for the heading."

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.