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

bpo-43950: Add documentation for PEP-657 #27047

Merged
merged 14 commits into from Jul 13, 2021
Merged

Conversation

ammaraskar
Copy link
Member

@ammaraskar ammaraskar commented Jul 6, 2021

First pass at documenting the feature.

https://bugs.python.org/issue43950

Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
@isidentical
Copy link
Sponsor Member

isidentical commented Jul 6, 2021

@ammaraskar can we separate co_positions() from traceback stuff? I think they are two separate features, and one masking the other right now might make users miss the co_positions() API.

@isidentical
Copy link
Sponsor Member

isidentical commented Jul 6, 2021

Thanks @ammaraskar for taking the first pass on documentation. I think overall it looks great!

@ammaraskar
Copy link
Member Author

ammaraskar commented Jul 6, 2021

@ammaraskar can we separate co_positions() from traceback stuff? I think they are two separate features, and one masking the other right now might make users miss the co_positions() API.

Added a separate section for this to make it harder to miss.

Copy link
Sponsor Member

@isidentical isidentical left a comment

LGTM

Doc/whatsnew/3.11.rst Show resolved Hide resolved
Doc/reference/datamodel.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
@ammaraskar
Copy link
Member Author

ammaraskar commented Jul 7, 2021

Rebased and squashed with the CPython specific column limit removed. Hopefully the documentation conveys that you should always be prepared to handle None with the API :)

Anything else to address here?

Copy link
Member

@pablogsal pablogsal left a comment

Let's focus next on finishing the specialized formats so the docs are up to date with that

@ammaraskar
Copy link
Member Author

ammaraskar commented Jul 12, 2021

Updated the existing examples for #27037 but maybe we should put an example of a complicated arithmetic expression to show off that specialization as well?

@pablogsal
Copy link
Member

pablogsal commented Jul 12, 2021

Updated the existing examples for #27037 but maybe we should put an example of a complicated arithmetic expression to show off that specialization as well?

Yeah, I want to also prepare in a separate PR some mini tutorial/example on how to use the Python fields.

We should also document "how to read the new tracebacks", especially for the specializations. For that, we should ask the one and only @willingc for advice on what's the best way to document it and where :)

ammaraskar and others added 3 commits Jul 12, 2021
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Co-authored-by: Batuhan Taskaya <batuhanosmantaskaya@gmail.com>
Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
@ammaraskar
Copy link
Member Author

ammaraskar commented Jul 12, 2021

Added an example for binary operations.

We should also document "how to read the new tracebacks"

Definitely, both of those sound good for follow-up docs. Maybe we can ask the overarching docs working group and specifically cc Carol in for help :)

@ammaraskar
Copy link
Member Author

ammaraskar commented Jul 12, 2021

Ready to go 🚀

Doc/c-api/code.rst Outdated Show resolved Hide resolved
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
- Running the interpreter with ``-X no_debug_ranges``.
- Loading a pyc file compiled while using ``-X no_debug_ranges``.
- Position tuples corresponding to artificial instructions.
- Line and column numbers that can't be represented due to
implementation specific limitations.
Copy link
Member

@pablogsal pablogsal Jul 12, 2021

Choose a reason for hiding this comment

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

Nice 👍

Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
ammaraskar and others added 2 commits Jul 12, 2021
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
Doc/reference/datamodel.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/reference/datamodel.rst Outdated Show resolved Hide resolved
Doc/reference/datamodel.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
@pablogsal pablogsal merged commit 9c3eaf8 into python:main Jul 13, 2021
12 of 13 checks passed
@ammaraskar ammaraskar deleted the pep657-docs branch Jul 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants