Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples with explanations in doc #233

Open
Okroshiashvili opened this issue Feb 27, 2023 · 2 comments
Open

Examples with explanations in doc #233

Okroshiashvili opened this issue Feb 27, 2023 · 2 comments

Comments

@Okroshiashvili
Copy link

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.

@joerick
Copy link
Owner

joerick commented Feb 27, 2023

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

@Okroshiashvili
Copy link
Author

Okroshiashvili commented Feb 27, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants