google-cloud-python icon indicating copy to clipboard operation
google-cloud-python copied to clipboard
verified publisher icon googleapis

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

Open rogerthatdev opened this issue 8 months ago • 1 comments

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

rogerthatdev avatar Apr 15 '25 19:04 rogerthatdev

@rogerthatdev Thanks for reporting this issue. The docs definitely aren't formatted properly. We will take a look!

ohmayr avatar Apr 22 '25 02:04 ohmayr