googleapis / googleapis/google-cloud-python

Use of colon and line break in doc string breaks formatting in IntelliSense

Offen
#13,793 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
priority: p3 type: docs
Vorherrschende Sprache
Python
Sterne
5.4k
Forks
1.8k
Ø Merge
3 T. 4 Std.
Gemergte PRs (30 T.)
122

Beschreibung

### Determine this is the right repository

- [x] I determined this is the correct repository in which to report this bug.

### Summary of the issue

**Context**
[These lines](https://github.com/googleapis/google-cloud-python/blob/4f87fe6583a44d0de55a951a51b00e95d6eceee0/packages/google-cloud-secret-manager/google/cloud/secretmanager_v1/services/secret_manager_service/client.py#L617-L621) cause bad formatting of doc string in IntelliSense hints in IDE. This is due to the use of a `:` and a line break.

**Expected Behavior:**
Readable doc string information within IDE tool tip

**Actual Behavior:**
Inconsistent text formatting.

Image

### API client name and version

_No response_

### Reproduction steps: code

_No response_

### Reproduction steps: supporting files

_No response_

### Reproduction steps: actual results

_No response_

### Reproduction steps: expected results

_No response_

### OS & version + platform

_No response_

### Python environment

_No response_

### Python dependencies

_No response_

### Additional context

_No response_

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.