Updating docstring of a class according to PEP 257 in a file

[ashish-hacker]

link to the concerned issue #4414

Depending on what your PR does, here are a few things you might want to address in the description:

• what are the (breaking) changes that this PR makes?

• This PR is about updating docstrings to PEP 257.

• important background, or details about the implementation

• Used PEP 257

• are the changes—especially new features—covered by tests and docstrings?

• Used PEP 257 for docstrings instead of numpy docstrings

• linting/style checks have been run

• Done style checking as mentioned in this

• consider adding/updating relevant example notebooks
• right before it's ready to merge, mention the PR in the RELEASE-NOTES.md

link to the changed docstrings

[ashish-hacker]

@michaelosthege Kindly review it.

[OriolAbril]

I think the numpydoc formatting should be kept and change only where the docstring is, I don't think napoleon supports that format.

Can you generate docs locally? I amnactually not sure if there is any documentation on how to do so anywhere

[michaelosthege]

Yes, the formatting of the Parameters section needs to remain the same.
And the first line in the __init__ docstring should be something like "Create an instance of a Metropolis stepper"

[twiecki]

This looks very different from all our other doc strings which follow the numpy style guide, can you make it adhere to that?

[ashish-hacker]

Oh Sorry! My bad. I will fix it right away

[ashish-hacker]

Done @twiecki : )

[twiecki]

Thanks @ashish-hacker!

[ashish-hacker]

Thanks @twiecki for merging. Can I do this for all the classes for all the files?

[Sayam753]

If the entire codebase docstrings are to be moved, it will be a good idea to ensure they follow numpy style using pydocstyle and fix them alongside. See #3713

[ashish-hacker]

Sure @Sayam753 :) Are you still working on #3713 ?

[Sayam753]

No. But will be happy to contribute in these infrastructural issues along with #4354 and #4044.
Also, I am not sure if there are plans to resolve them before or after v4 release.