Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
Open
Description
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
Projects
Status
Todo