podman-py icon indicating copy to clipboard operation
podman-py copied to clipboard

Inconsistent docstring format used throughout

Open jonathanunderwood opened this issue 2 years ago • 4 comments

The docstring format used throughout the project is inconsistent. Sometimes they are reminiscent of Google docstrings, sometimes they look like numpy docstrings. A decision needs to be made and documented on the required docstring format to enable contributors to improve the docstrings.

jonathanunderwood avatar Dec 27 '21 23:12 jonathanunderwood

@mwhahaha @jwhonce WDYT?

rhatdan avatar Dec 28 '21 10:12 rhatdan

I vote for Google format

jwhonce avatar Jan 24 '22 15:01 jwhonce

I have no opinion so Google format would be fine.

mwhahaha avatar Jan 24 '22 15:01 mwhahaha

@jonathanunderwood Can you open a PR to document this.

rhatdan avatar Jan 24 '22 18:01 rhatdan

So I recently did a rework of the docs to be able to publish them to readthedocs and build without errors. The current documentation on readthedocs contain all the information a user would need for using the podman-py API and is clear. I don't think there is anything else to fix here given @jwhonce also added the clarification in the contributing.md.

Link to our readthedocs https://podman-py.readthedocs.io/en/latest/index.html.

umohnani8 avatar Jan 23 '24 12:01 umohnani8