GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-29086: Add stableabi option to Documentation by WillAyd · Pull Request #23185 · python/cpython

Conversation

@WillAyd

@WillAyd WillAyd commented Nov 6, 2020 •
edited by miss-islington
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Starting as a draft for now, as there are quite a few ways to go about this. I figured this first approach, while verbose, has the upside of leveraging functionality that has already been built into the documentation. Happy to expand to other functions if we think this is in the right direction

https://bugs.python.org/issue29086

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@WillAyd
Updated datetime documentation
a3b9c17
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Nov 6, 2020
@WillAyd

WillAyd commented Nov 6, 2020

Copy link
Copy Markdown
Contributor Author

This is how it renders:

image
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Fidget-Spinner
Fidget-Spinner reviewed Nov 7, 2020
View reviewed changes

@Fidget-Spinner Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

This LGTM, the only problem is that nearly all the :stableabi: markup has trailing whitespace and tabs, this is causing both the Travis CI checks and Azure pipelines to fail.

Usually I'd advise running make patcheck. However, you might want to do this using your own IDE/manually since it occasionally re-indents/de-indents unrelated parts of the documentation (from personal experience).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@WillAyd
whitespace fix
1b7d971
@WillAyd
WillAyd marked this pull request as ready for review November 10, 2020 18:51
@WillAyd
WillAyd requested review from abalkin and pganssle as code owners November 10, 2020 18:51
Fidget-Spinner
Fidget-Spinner approved these changes Nov 10, 2020
View reviewed changes
@bedevere-bot bedevere-bot added awaiting core review and removed awaiting review labels Nov 10, 2020
@github-actions

github-actions Bot commented Dec 16, 2020

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Dec 16, 2020
@WillAyd

WillAyd commented Dec 16, 2020

Copy link
Copy Markdown
Contributor Author

Not stale just awaiting core review
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta Mariatta added the skip news label Dec 16, 2020
Mariatta
Mariatta approved these changes Dec 16, 2020
View reviewed changes

@Mariatta Mariatta left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Looks great to me. Thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Dec 16, 2020
@Mariatta

Mariatta commented Dec 16, 2020

Copy link
Copy Markdown
Member

Does this need backport?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Dec 17, 2020
@Mariatta Mariatta added the 🤖 automerge label Dec 17, 2020
@WillAyd

WillAyd commented Dec 17, 2020

Copy link
Copy Markdown
Contributor Author

Not sure what your backport policy is. It could be since it has been this way for a while, though at the same time the change is relatively minor
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta Mariatta added needs backport to 3.8 and removed 🤖 automerge labels Dec 17, 2020
@encukou encukou removed the 🤖 automerge label Dec 31, 2020
@encukou

encukou commented Dec 31, 2020

Copy link
Copy Markdown
Member

Hi,
Can we please hold off on this PR for a few weeks? I am writing a PEP about the stable ABI.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mariatta Mariatta added the DO-NOT-MERGE label Dec 31, 2020
@Mariatta

Mariatta commented Dec 31, 2020

Copy link
Copy Markdown
Member

No prob, @encukou .I've added the do-not-merge label for now.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@encukou

encukou commented Dec 31, 2020

Copy link
Copy Markdown
Member

I've just put up a first draft of the PEP at: https://github.com/encukou/abi3/blob/main/PEP.rst
and kicked off a discussion at: https://mail.python.org/archives/list/[email protected]/thread/PMM5QG4IAL6LOMNFXNHW72INSCN4JC5H/
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions

github-actions Bot commented Feb 2, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Feb 2, 2021
@encukou

encukou commented Feb 2, 2021

Copy link
Copy Markdown
Member

The PEP is almost ready: https://discuss.python.org/t/pre-pep-maintaining-the-stable-abi/6986

@WillAyd, do you mind if I close this PR and take over the effort?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@encukou encukou removed the stale Stale PR or inactive for long period of time. label Feb 2, 2021
@WillAyd

WillAyd commented Feb 2, 2021 via email

Copy link
Copy Markdown
Contributor Author
Not a problem at all - great work on the PEP
…
Sent from my iPhone
On Feb 2, 2021, at 1:42 PM, Petr Viktorin ***@***.***> wrote:  The PEP is almost ready: https://discuss.python.org/t/pre-pep-maintaining-the-stable-abi/6986 @WillAyd, do you mind if I close this PR and take over the effort? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.
encukou reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@encukou encukou closed this Feb 2, 2021
encukou added a commit to encukou/cpython that referenced this pull request Apr 29, 2021
@encukou @WillAyd
Add "Part of the Stable ABI" annotations to the documentation
179c132 
This replaces the existing :stableabi:, which wasn't really used.

Doc/data/stable_abi.dat is expanded to include all relevant
info (kind of the symbol and version it was added in), and the
c_annotations Sphinx extension reads this file and adds
notes similar to ones added by :stableabi: (which wasn't really
used).

Relevant prior work: python#23185
Co-authored-by: Will Ayd <[email protected]>
@encukou

encukou commented Apr 29, 2021

Copy link
Copy Markdown
Member

GH-25668 proposes to add the notes, along with when a particular API was added.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@WillAyd
WillAyd deleted the limited-doc-updates branch November 6, 2022 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mariatta Mariatta Mariatta approved these changes
@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes
@abalkin abalkin Awaiting requested review from abalkin
@pganssle pganssle Awaiting requested review from pganssle

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting merge DO-NOT-MERGE docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@WillAyd @Mariatta @encukou @Fidget-Spinner @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.