Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.3k
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).
- Report including private names:https://gist.github.com/picnixz/d4aa5ff5e82013966dc575f0709c4398#file-full-report-md
- Report for publicly-named API:https://gist.github.com/picnixz/d4aa5ff5e82013966dc575f0709c4398#file-report-md
Both reports parse private files as well as they can be re-exported to a public API. We still need to go through each occurrences to check if they are expected to be exposed or not (and thus the task isNOT an easy task for newcomers).
Linked PRs
Metadata
Metadata
Assignees
Labels
Projects
Status