Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upFeature request: consider supporting 2-spaces-indentation #5
Comments
kernc
added this to the 0.5.2 milestone
Jan 24, 2019
This comment has been minimized.
This comment has been minimized.
|
I was reluctant to accept this at first as everybody knows that the one true legible indentation style for Python is 4-space indentation. But apparently there really are well-established projects that remain to follow the old Google pystyle recommendation of 2-space indents. It thus makes sense, I guess, to support this indentation in Google-style docstrings as well. |
kernc
closed this
in
e2739ce
Jan 24, 2019
This comment has been minimized.
This comment has been minimized.
|
Thanks a lot for the update. Indeed, the issue is because of google's old and internal styles. FYI, I'm using pdoc for this repo, which is based on 2-space indentation. Generated docs now look great! Thanks for the changes. |
This comment has been minimized.
This comment has been minimized.
|
Support for Google docstrings is fairly recent. If you have any other ideas for improvement, they are very welcome. |
wq2012 commentedJan 22, 2019
Expected Behavior
Some python libraries use 2-spaces-indentation instead of 4 spaces or single tab.
The user would expect being able to use an argument to support that.
Actual Behavior
Currently no argument seems to support that.
And by default it will generate badly formatted documentation for such libraries.
Steps to Reproduce
N/A
Additional info
0.5.1