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

guide: fixes and some minor additions #802

Merged
merged 3 commits into from
Mar 13, 2020
Merged

Conversation

birkenfeld
Copy link
Member

I went through the guide and fixed grammar/consistency/indentation issues,
and added some wording where I thought it appropriate.

I also reordered the chapters to what I feel is a more natural
flow of concepts.

I went through the guide and fixed some grammar/consistency issues,
and added some wording where I thought it appropriate.

I also reordered the chapters to what I feel is a more natural
flow of concepts.
Copy link
Member

@davidhewitt davidhewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, thank you so much for doing this! Great docs are so important for OSS projects. I personally suck at finding time to add to them though 😝

I chipped in with a few extra suggestions.

Comment on lines +34 to 36
## `*args` and `**kwargs` for Python object calls

There are several ways how to pass positional and keyword arguments to a Python object call.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we maybe call these "Python function calls" instead of "Python object calls"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me both are fine; there isn't a big distinction between calling functions and calling other callables, such as classes to create an instance.

guide/src/exception.md Outdated Show resolved Hide resolved
guide/src/function.md Outdated Show resolved Hide resolved
guide/src/function.md Outdated Show resolved Hide resolved
guide/src/function.md Outdated Show resolved Hide resolved
guide/src/function.md Outdated Show resolved Hide resolved
guide/src/pypy.md Outdated Show resolved Hide resolved
guide/src/exception.md Outdated Show resolved Hide resolved
guide/src/class.md Show resolved Hide resolved
guide/src/class.md Show resolved Hide resolved
guide/src/conversions.md Outdated Show resolved Hide resolved
@kngwyu
Copy link
Member

kngwyu commented Mar 13, 2020

Awesome, thank you for so many improvements!
Actually I'm not so experienced at writing documents and learn a lot for your diff 🙂

Looks the test failure is caused by missing ignore for a code block.

Co-Authored-By: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
Co-Authored-By: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
@kngwyu kngwyu merged commit 3f030d4 into PyO3:master Mar 13, 2020
@birkenfeld birkenfeld deleted the guide-fixes branch March 13, 2020 14:11
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

Successfully merging this pull request may close these issues.

3 participants