Skip to content

doc indentation incorrect when previous line starts with a non-list number: #1765

@vchudnov-g

Description

@vchudnov-g

I had to manually fix a google-cloud-python PR that had a cpmment looking like this:

            project_number (int):
                The Google cloud project number, e.g.
                1234567890. A value of 0 indicates no project
                    number is found.

The leading number followed by a period at the start of a line looks like a list item, so subsequent lines are further indented. One workaround might be to treat such numbers as numbered list items iff they are either 1 (or 0?), or if they have a value one higher than the previous such number encountered.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p2Moderately-important priority. Fix may not be included in next release.type: docsImprovement to the documentation for an API.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions