Closed vEpiphyte closed 4 years ago
You are right on that. Let's be more explicit on how we run the examples.
And plus: examples in the current documentation are very poor compared to the current feature set of Yappi, IMHO. I think we should be providing more and more examples explaining every subtle detail like this. Thanks for pointing out.
But I could not understand this part:
Since the docs aren't in git, I can't make a PR to update them.
You might have missed this one? : https://github.com/sumerc/yappi/tree/master/doc
I would be more than happy to accept any kind of PR related to giving examples on these. We can even write a full separate document dedicated only on usage examples.
Oopps! I totally missed that the docs were inline - for some reason i assumed they were github wiki pages. I can throw a PR up for fixing the asyncio example easily; however i'm uncertain how you generated the displayed blob of results.
Yeah: they are generated for wall time as you guessed. (yappi -c wall
)
I will be closing this issue since I have included some examples on README.md in a new brach improve-filtering. Updated/Improved most of the docs and examples.
Since the docs aren't in git, I can't make a PR to update them.
edit: Environment: Ubuntu 18.04, python 3.7.3, yappi 1.2.3