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

Docs build in google-cloud-documentai fails with Unexpected section title. #1838

Open
parthea opened this issue Nov 2, 2023 · 0 comments
Open
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@parthea
Copy link
Contributor

parthea commented Nov 2, 2023

I had to manually fix the docs build to unblock a release PR that had a comment looking like this:

            Currently support query strings are:
            ------------------------------------

            ``SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED``

The issue is that the source proto is missing a hyphen for a list item. In addition, there are headings used in the proto comments which are not allowed according to https://google.aip.dev/192#formatting.

https://github.com/googleapis/googleapis/blob/a70dd17d128746c3ce9f3f116fc6404cfdb92f15/google/cloud/documentai/v1beta3/document_service.proto#L301-L307

  // ## Currently support query strings are:
  //
  // `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
  // - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
  // - `DisplayName=\"file_name.pdf\"`
  // - `EntityType=abc/def`
  // - `TagName=\"auto-labeling-running\"|\"sampled\"`

The supported format is

  // Currently support query strings are:
  //
  // - `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
  // - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
  // - `DisplayName=\"file_name.pdf\"`
  // - `EntityType=abc/def`
  // - `TagName=\"auto-labeling-running\"|\"sampled\"`
parthea added a commit to googleapis/google-cloud-python that referenced this issue Nov 2, 2023
@vchudnov-g vchudnov-g added the priority: p2 Moderately-important priority. Fix may not be included in next release. label Nov 6, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
@parthea parthea added the type: cleanup An internal cleanup or hygiene concern. label Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 13, 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 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 Mar 5, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Apr 17, 2024
@parthea parthea added type: docs Improvement to the documentation for an API. priority: p3 Desirable enhancement or fix. May not be included in next release. and removed type: cleanup An internal cleanup or hygiene concern. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Apr 23, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 11, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 15, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 29, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 8, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 30, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jul 31, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 6, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or 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

2 participants