Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

[Python] generated docstrings for 'google.cloud.container_v1.types.Cluster' break docs build #2449

Closed
tseaver opened this issue Nov 21, 2018 · 7 comments
Assignees
Labels
lang: python Issues specific to Python. priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@tseaver
Copy link
Contributor

tseaver commented Nov 21, 2018

  File "/home/tseaver/projects/agendaless/Google/src/gcp/.nox/docs/lib/python3.6/site-packages/sphinx/util/logging.py", line 410, in filter
    raise SphinxWarning(location + ":" + message)
sphinx.errors.SphinxWarning: /home/tseaver/projects/agendaless/Google/src/gcp/container/google/cloud/container_v1/types.py:docstring of google.cloud.container_v1.types.Cluster:185:Inline interpreted text or phrase reference start-string without end-string.
> /home/tseaver/projects/agendaless/Google/src/gcp/.nox/docs/lib/python3.6/site-packages/sphinx/util/logging.py(410)filter()
-> raise SphinxWarning(location + ":" + message)
(Pdb) pp location
('/home/tseaver/projects/agendaless/Google/src/gcp/container/google/cloud/container_v1/types.py:docstring 

The actual file containing that docstring is google/cloud/container_v1/proto/cluster_service_pb2.py. The offending bit is:

      current_node_version:
          [Output only] Deprecated, use `NodePool.version </kubernetes-e
          ngine/docs/reference/rest/v1/projects.zones.clusters.nodePool>
          `__ instead. The current version of the node software
          components. If they are currently at multiple versions because
          they're in the process of being upgraded, this reflects the
          minimum version of all nodes.

where the backtick-double-underscore is wrapped away from the closing angle bracket.

@tseaver tseaver added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. lang: python Issues specific to Python. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Nov 21, 2018
tseaver added a commit to googleapis/google-cloud-python that referenced this issue Nov 21, 2018
Includes fixes from these PRs:

- googleapis/gapic-generator#2407
- googleapis/gapic-generator#2396

Includes changes to generated tests.

Includes synth replacements to work around generated docstring issue:

- googleapis/gapic-generator/issues/2449

Closes #6483.
@andreamlin
Copy link
Contributor

@tseaver How much of a blocker is this for the Yoshi team? We can bump this to a P1 if it's introducing a lot of toil on your end.

@tseaver
Copy link
Contributor Author

tseaver commented Nov 26, 2018

@andreamlin

How much of a blocker is this for the Yoshi team? We can bump this to a P1 if it's introducing a lot of toil on your end.

Thanks, but /google-cloud-python/pull/6634/ adds a workaround for it in container/synth.py, so we aren't blocked.

erikwebb pushed a commit to erikwebb/google-cloud-python that referenced this issue Dec 3, 2018
Includes fixes from these PRs:

- googleapis/gapic-generator#2407
- googleapis/gapic-generator#2396

Includes changes to generated tests.

Includes synth replacements to work around generated docstring issue:

- googleapis/gapic-generator/issues/2449

Closes googleapis#6483.
@vchudnov-g
Copy link
Contributor

@lukesneeringer Could you provide an update? (We're about to pass the SLO window on this one)

@noahdietz
Copy link
Contributor

Is this related to a line wrapping bug #2159 ?

@JustinBeckwith JustinBeckwith added the 🚨 This issue needs some love. label Jun 27, 2019
@vchudnov-g
Copy link
Contributor

@lukesneeringer @hzyi-google Any updates on this? We're out of SLO.

@tseaver
Copy link
Contributor Author

tseaver commented Aug 5, 2019

FWIW, the workaround added in googleapis/google-cloud-python#6634 is still in effect when generating google-cloud-container:

synthtool > Replaced 'nodePool>\\n' in google/cloud/container_v1/proto/cluster_service_pb2.py.
synthtool > Replaced '(\\s+)`__ instead' in google/cloud/container_v1/proto/cluster_service_pb2.py.

busunkim96 pushed a commit to googleapis/python-container that referenced this issue Jan 31, 2020
Includes fixes from these PRs:

- googleapis/gapic-generator#2407
- googleapis/gapic-generator#2396

Includes changes to generated tests.

Includes synth replacements to work around generated docstring issue:

- googleapis/gapic-generator/issues/2449

Closes #6483.
@vchudnov-g
Copy link
Contributor

@software-dov Any updates on this? Feel free to close if this becomes a non-issue because of the µ-generators.

@AlanGasperini AlanGasperini added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. labels Feb 7, 2020
@yoshi-automation yoshi-automation removed the 🚨 This issue needs some love. label Feb 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lang: python Issues specific to Python. priority: p3 Desirable enhancement or fix. May not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

10 participants