Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Replace# comments with modern docstrings when possible #134082

Open
Assignees
picnixz
Labels
docsDocumentation in the Doc dirstdlibPython modules in the Lib dirtype-featureA feature request or enhancement
@picnixz

Description

@picnixz

Instring.Formatter.{parse,get_field}, we use simple# comments to document methods. While it's picked up by pydoc (throughinspect.getcomments()), it's not picked up by IDEs. I suggest we cleanup those occurrences to improve code readability as well. I stumbled upon it by chance so there might be other places that need such cleanup.

Important

Only comments that areabove adef of a public function should be considered. Comments inside the function body or method body should be considered separately as it could also mean that the public API is incompletely documented on purpose (see#134082 (comment) and following).

Linked PRs

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirstdlibPython modules in the Lib dirtype-featureA feature request or enhancement

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions


    [8]ページ先頭

    ©2009-2025 Movatter.jp