PyFilesystem / pyfilesystem

Python filesystem abstraction layer
http://pyfilesystem.org/
BSD 3-Clause "New" or "Revised" License
285 stars 63 forks source link

Docstrings are inconsistent (sanctioning convention) #229

Closed arekbulski closed 8 years ago

arekbulski commented 8 years ago

I found several issues with the docstrings in the base FS class, but most dont seem to require much justification to change them. Once I am through with all the changes, I will put a Pull Request. I am pretty sure you will find all the clarifications justified (and corrections right).

There is a convention that I would like to be officially sanctioned, so we can keep the docstrings written in some unified, consistent way. Once sanctioned, I will apply it to my Pull Request.

@willmcgugan Please give a go?

willmcgugan commented 8 years ago

Docstrings, I see little point in changing. I don't always have wrapping on, because auto-wrapped code can be hard to read. Sphinx copes with the indentation as it is.

Method signatures, definitely not. It is fairly common, and blessed in pep8 to wrap long signatures like that.

I'm not apposed to tidying up of the code, but it has to be either pep8, or some justification other than personal preference behind it.

arekbulski commented 8 years ago

I withdraw the patch, it was too complex. I will resubmit with more strictly necessary changes to documentation.