You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I have a few suggestions to improve the documentation of freezegun:
1. Undocumented features: At least the real_asyncio parameter is undocumented. I accidentally found it when reading the code trying to figure out how to make asyncio.sleep work. When searching for it the only documentation is a comment inside the api.py code. There may be other undocumented features, I didn't check all of them.
2. Docstrings: It would be great to have docstrings so I could see documentation directly inside the IDE, instead of jumping to a website.
3. API documentation: While examples are great, I would appreciate also succinct API documentation with all options listed and documented. Examples are a bit hit-and-miss, you have to read through all examples to see whether a feature you're looking for is present or not. Though of the three, this is the lowest priority for me.