Added a clause for "indented-line" blocks for the Python style guide #537
Conversation
|
@gpshead any progress on this? |
| def print_data(verbose): | ||
| """Prints information about the user's environment. | ||
|
|
||
| Args: |
There was a problem hiding this comment.
Can we also clarify what to do in case of a mix of both the styles? And add an example for that as well?
There was a problem hiding this comment.
in general i favor not being over prescriptive about that. the main consistency thing is the indentation level (which is already mentioned). but trying to enumerate a matrix of possible argument or exception and their descriptions style mixes for things would explode meaninglessly and become an enemy of documentation. :)
There was a problem hiding this comment.
As long as "hanging indent" style is allowed by the standard, I'm happy for maintainers of tools to decide whether or not to enforce consistency. Avoiding being over prescriptive and having the option to pick the right look for the right doc would be a great thing.
|
@gpshead could you please update on this review? Or give details on how to advance this PR? |
|
I just mailed an internal change that should address this. I'll make sure the the external guide is synced after that goes in. |
|
An update including my internal change addressing this has been pushed. |
There's a discussion going on in pydocstyle (Reference: PyCQA/pydocstyle#449) about what whitespace options are allowed under google's style guide. In this issue submitted to this repository, it was mentioned that using indented lines is allowed by Google's current linters.
Would it be alright to add an explicit example?