Skip to content

Document the co_lines method on code objects - #113682

Merged
AlexWaygood merged 4 commits into
python:mainfrom
AlexWaygood:document-co-lines
Jan 3, 2024
Merged

Document the co_lines method on code objects#113682
AlexWaygood merged 4 commits into
python:mainfrom
AlexWaygood:document-co-lines

Conversation

@AlexWaygood

@AlexWaygoodAlexWaygood commented Jan 3, 2024•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

I noticed while preparing #112781 that this method wasn't documented properly, despite several deprecated things (that the method was meant to replace) being documented. So let's document it!

Most of the docs here are just copied from PEP-626: https://peps.python.org/pep-0626/#the-new-co-lines-method-of-code-objects

📚 Documentation preview 📚: https://cpython-previews--113682.org.readthedocs.build/

hugovk
hugovk reviewed Jan 3, 2024
View reviewed changes
Comment threadDoc/reference/datamodel.rst Outdated
AlexWaygoodand others added 2 commits January 3, 2024 17:21
@AlexWaygood@hugovk
.
cbeba88
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygood
Too many semicolons! I never thought it was possible
ba2c504
AlexWaygood
AlexWaygood commented Jan 3, 2024
View reviewed changes
Comment threadDoc/reference/datamodel.rst Outdated
@AlexWaygood

AlexWaygood commented Jan 3, 2024

Copy link
Copy Markdown
MemberAuthor

It looks like I maybe still haven't got the formatting quite right for the .. seealso:: box, but I'm not sure what I'm doing wrong.

This .. seealso:: box:

Details

image

Other .. seealso:: box (has a nice line break in between the "See also" heading and the next line):

Details

image

The other one is here:

cpython/Doc/reference/datamodel.rst

Lines 2010 to 2013 in 178919c

.. seealso::
:pep:`562` - Module __getattr__ and __dir__
Describes the ``__getattr__`` and ``__dir__`` functions on modules.

@Eclips4

Eclips4 commented Jan 3, 2024•
edited
Loading

Copy link
Copy Markdown
Member

It's looks good for me:

Details

image

@hugovk

hugovk commented Jan 3, 2024•
edited
Loading

Copy link
Copy Markdown
Member

Also good for me on mobile:

Details

Screenshot_20240103_211511_Chrome

@AlexWaygood

AlexWaygood commented Jan 3, 2024

Copy link
Copy Markdown
MemberAuthor

Weird, I'm still seeing it on Firefox (have tried clearing the cache, still seeing it), but not on Opera. Eh, not the biggest issue in the world anyway :)

@AlexWaygood
AlexWaygood merged commit f1f8392 into python:mainJan 3, 2024
@AlexWaygood
AlexWaygood deleted the document-co-lines branch January 3, 2024 19:29
@miss-islington-app

miss-islington-appBot commented Jan 3, 2024

Copy link
Copy Markdown

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-appBot commented Jan 3, 2024

Copy link
Copy Markdown

Sorry, @AlexWaygood, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker f1f839243251fef7422c31d6a7c3c747e0b5e27c 3.12

@miss-islington-app

miss-islington-appBot commented Jan 3, 2024

Copy link
Copy Markdown

Sorry, @AlexWaygood, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker f1f839243251fef7422c31d6a7c3c747e0b5e27c 3.11

@bedevere-app

bedevere-appBot commented Jan 3, 2024

Copy link
Copy Markdown

GH-113686 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label Jan 3, 2024
@AlexWaygoodAlexWaygood removed the needs backport to 3.11 only security fixes label Jan 3, 2024
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Jan 3, 2024
@AlexWaygood@hugovk
[3.12] Document theco_linesmethod on code objects (python#113682)
30920d7
(cherry-picked from commit f1f8392)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Jan 3, 2024

Copy link
Copy Markdown

GH-113687 is a backport of this pull request to the 3.11 branch.

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Jan 3, 2024
@AlexWaygood@hugovk
[3.11] Document theco_linesmethod on code objects (python#113682)
1ae643d
(cherry-picked from commit f1f8392)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood added a commit that referenced this pull request Jan 3, 2024
@AlexWaygood@hugovk
[3.11] Document theco_linesmethod on code objects (#113682) (#113687
c828dbc
)
(cherry-picked from commit f1f8392)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AlexWaygood added a commit that referenced this pull request Jan 3, 2024
@AlexWaygood@hugovk
[3.12] Document theco_linesmethod on code objects (#113682) (#113686
d3f2051
)
(cherry-picked from commit f1f8392)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
@AlexWaygood@hugovk@kulikjak
Document theco_linesmethod on code objects (python#113682)
1ab50e0
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood@hugovk@aisk
Document theco_linesmethod on code objects (python#113682)
8b8f285
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygoodAlexWaygood mentioned this pull request Sep 1, 2024
Closed
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood@hugovk@Glyphack
Document theco_linesmethod on code objects (python#113682)
ad9f2f2
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovkhugovkhugovk approved these changes

Assignees

@AlexWaygoodAlexWaygood

Labels

skip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AlexWaygood@Eclips4@hugovk