Standardize `docstring` format

huawei-noah / SMARTS

Scalable Multi-Agent RL Training School for Autonomous Driving

MIT License

944 stars 190 forks source link

Standardize `docstring` format #1263

Open Gamenot opened 2 years ago

Gamenot commented 2 years ago

Is your feature request related to a problem? Please describe. docstring format is varied across our source files. This makes documentation harder to work with.

Describe the solution you'd like Pick a standard docstring format. One option is the Google docstring format as demonstrated here: https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e

Additional context Some relevant discussion: https://github.com/huawei-noah/SMARTS/pull/1248#discussion_r794870600

Gamenot commented 1 year ago

We may be able to use something like pyment to correct our docstrings.

https://github.com/dadadel/pyment