Constructor arguments recorded as "attributes" in class docstrings.

AIDynamicAction / rcognita

rcognita is a flexibly configurable framework for agent-enviroment simulation with a menu of predictive and safe reinforcement learning controllers

MIT License

16 stars 7 forks source link

Constructor arguments recorded as "attributes" in class docstrings. #23

Closed yaremenko8 closed 3 years ago

yaremenko8 commented 3 years ago

__init__ should have a docstring of its own. The "Attributes" section in class dosctrings is reserved for attributes. Violating this convention really messes up the wiki. We should fix that (preferably by next release I think) and from now on proceed to document new classes conventionally.