googleapis / googleapis/google-cloud-python

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

Open
#13,793 2 comments 0 reactions 0 assignees View on GitHub
priority: p3 type: docs
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.