gh-134082: Modernize docstrings in string.Formatter
#134083
Conversation
| # loop through the rest of the field_name, doing | ||
| # getattr or getitem as needed | ||
| for is_attr, i in rest: | ||
| if is_attr: | ||
| obj = getattr(obj, i) | ||
| else: | ||
| obj = obj[i] | ||
|
|
There was a problem hiding this comment.
why remove empty lines that provide «breathing space» and make it easy to follow the code?
There was a problem hiding this comment.
Mmh, I shouldn't have removed those ones indeed. My bad. I however think that too many empty lines hinder the flow but I should have left them out in this case. I'll try to keep in mind. Note that from what I saw in more modern code, we tend to avoid too many blank lines in general except in long functions where logical sections are split.
There was a problem hiding this comment.
I agree with @picnixz. PEP 8 says to use a single blank line to separate methods and two blank lines to separate top-level functions and classes (there are also exceptions). https://peps.python.org/pep-0008/#blank-lines
We don't usually make changes solely to meet PEP 8 requirements, but in this case I think it was justified.
string.Formatteris using legacy docstrings that are picked up by pydoc but are not by modern IDEs. I suggest changing them to regular docstrings.#comments with modern docstrings when possible #134082