open-spaced-repetition / py-fsrs

Python Package for FSRS
https://pypi.org/project/fsrs/
MIT License
147 stars 23 forks source link

Add docstrings #58

Closed joshdavham closed 2 months ago

joshdavham commented 2 months ago

I went and added some basic docstrings to the source code to make it easier for other people to understand.

Specifically, I added docstrings to each module, class and also the most 'public' methods that developers are mostly likely to invoke such as review_card and to_dict.

Let me know if there are any issues / questions 👍