gapic-generator-python icon indicating copy to clipboard operation
gapic-generator-python copied to clipboard

docs build failed in google-maps-routing

Open parthea opened this issue 1 year ago • 0 comments

See the build log below where the docs build for google-maps-routing failed with

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-maps-routing/google/maps/routing_v2/types/toll_passes.py:docstring of google.maps.routing_v2.types.toll_passes.TollPass:59:Unexpected indentation.

https://github.com/googleapis/google-cloud-python/actions/runs/7934450775/job/21665468219?pr=12314

The issue is that this docstring is missing an empty line before the list

        ID_E_TOLL (16):
            Indonesia.
            E-card provided by multiple banks used to pay
            for tolls. All e-cards via banks are charged the
            same so only one enum value is needed. E.g.
            - Bank Mandiri
              https://www.bankmandiri.co.id/e-money
            - BCA https://www.bca.co.id/flazz
            - BNI
              https://www.bni.co.id/id-id/ebanking/tapcash

The following change appears to fix the issue

        ID_E_TOLL (16):
            Indonesia.
            E-card provided by multiple banks used to pay
            for tolls. All e-cards via banks are charged the
            same so only one enum value is needed. E.g.

            - Bank Mandiri
              https://www.bankmandiri.co.id/e-money
            - BCA https://www.bca.co.id/flazz
            - BNI
              https://www.bni.co.id/id-id/ebanking/tapcash

parthea avatar Feb 21 '24 20:02 parthea