CCL icon indicating copy to clipboard operation
CCL copied to clipboard

Docstrings are formatted badly.

Open nikfilippas opened this issue 2 years ago • 3 comments

Most docstrings do not adhere to any formatting standard. As a result of this

  1. they are hard to read directly from the source code as they are very cluttered
  2. every developer uses their own style so there's a bunch of different styles currently implemented
  3. they don't integrate well with any IDE.

For example, this docstring: Screenshot from 2022-08-04 15-31-00 shows like this in the IDE Screenshot from 2022-08-04 15-25-39

We should adopt a developer's style guide. Copying numpy's style guide is a very good choice. Look what difference it makes in the source code's readability and the IDE: Screenshot from 2022-08-04 15-31-13 Screenshot from 2022-08-04 15-25-10

nikfilippas avatar Aug 04 '22 12:08 nikfilippas

I'd like to give the docs a full sweep once we merge everything that goes right before v2 and then right before we publish v3

damonge avatar Aug 04 '22 12:08 damonge

yeah me too, I've already started doing that in my dev branches

nikfilippas avatar Aug 04 '22 12:08 nikfilippas

OK, but don't waste too much time on that. We will need to do a final exhaustive sweep anyway.

damonge avatar Aug 04 '22 13:08 damonge