Skip to content
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

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

Open
vchudnov-g opened this issue Sep 14, 2023 · 0 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@vchudnov-g
Copy link
Contributor

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.

@vchudnov-g vchudnov-g added type: docs Improvement to the documentation for an API. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Sep 14, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 19, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 19, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 30, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 30, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 30, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Nov 2, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Nov 2, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 19, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 3, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 14, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 22, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

1 participant