pyinstrument icon indicating copy to clipboard operation
pyinstrument copied to clipboard

Examples with explanations in doc

Open Okroshiashvili opened this issue 1 year ago • 2 comments

It would be really helpful for newcomers to have example outputs and explanations in docs. For example, I spent few hours looking what [self] means in HTML output. I'm sure there will be other cases when there is something different than [self] and it's hard for newcomers to explain why their code spends most of the time there.

Okroshiashvili avatar Feb 27 '23 07:02 Okroshiashvili

Yeah, great idea! Are there any other things that tripped you up as a newcomer?

joerick avatar Feb 27 '23 09:02 joerick

I guess, yes @joerick

For example, if a class defines __call__ method. There will be something... not sure what but...

You can start adding these two and if I will encounter anything else, I'll let you know

Okroshiashvili avatar Feb 27 '23 09:02 Okroshiashvili