googleapis / googleapis/google-cloud-python

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

オープン
#13,793 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
priority: p3 type: docs
主要言語
Python
スター
5.4k
フォーク
1.8k
平均マージ
3日 4時間
マージ済み PR(30日)
122

説明

### 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_

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。