RASA Docstring style

Rasa Open Source
1

Hi everyone. I am currently writing documentation (specifically Docstrings), and came across some existing documentation that had me curious. I am not 100% sure if this is the case with other classes in the repository, and correct me if I am wrong, but in rasa/core/tracker_store.py, it appears that the multi-line Docstrings are in Google Style Format. Here is an example:

multi%20line%20docstring
multi%20line%20docstring1194Ă—818 88.1 KB

Is this the preferred Docstring format for RASA? Thank you in advance.

2

Hey @alandas99, you are correct, Google Style Format is the preferred documentation style. Note that we omit specifying the types because they are already annotated on the function’s signature. Exceptions are still documented with type and description (e.g. “ValueError: when arg is invalid.”).

1 Like