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

gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide #119232

Merged
merged 5 commits into from
May 20, 2024

Conversation

shaunagm
Copy link
Sponsor Contributor

@shaunagm shaunagm commented May 20, 2024

Note: I am a first-time contributor, so apologies if I've missed some important norms or processes.

This is an attempt to fix #118912 by removing the description of a bug that was removed in Python 3.5. I noticed that elsewhere in the documentation there were comments about when something had been added or removed or changed, so I tried using that here. Not sure if that was actually appropriate.

I had one other question: the autospeccing guide feels a little out of place here. Everything else seems to be primarily for reference, while this guide feels like more of a howto. Should it be moved to a howto section, and merely linked here? If we want to keep it in this part of the docs, should it be moved next to create_autospec or even submerged into it? Eager to get your thoughts on this question, and to get overall feedback on this PR.


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

Copy link

cpython-cla-bot bot commented May 20, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks @shaunagm

@willingc willingc enabled auto-merge (squash) May 20, 2024 19:43
@willingc willingc merged commit 7e57640 into python:main May 20, 2024
25 checks passed
@willingc willingc added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels May 20, 2024
@miss-islington-app
Copy link

Thanks @shaunagm for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @shaunagm for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 20, 2024
…eccing guide (pythonGH-119232)

* Remove description of issue fixed in 3.5 from autospeccing guide

* Make autospeccing note text more succint and lint whitespace

* Add linting changes (missed in last commit)

---------

(cherry picked from commit 7e57640)

Co-authored-by: Shauna <shaunagm@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 20, 2024
…eccing guide (pythonGH-119232)

* Remove description of issue fixed in 3.5 from autospeccing guide

* Make autospeccing note text more succint and lint whitespace

* Add linting changes (missed in last commit)

---------

(cherry picked from commit 7e57640)

Co-authored-by: Shauna <shaunagm@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
@bedevere-app
Copy link

bedevere-app bot commented May 20, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label May 20, 2024
@bedevere-app
Copy link

bedevere-app bot commented May 20, 2024

GH-119284 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 20, 2024
willingc added a commit that referenced this pull request May 20, 2024
…peccing guide (GH-119232) (#119283)

gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232)

* Remove description of issue fixed in 3.5 from autospeccing guide

* Make autospeccing note text more succint and lint whitespace

* Add linting changes (missed in last commit)

---------

(cherry picked from commit 7e57640)

Co-authored-by: Shauna <shaunagm@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
willingc added a commit that referenced this pull request May 20, 2024
…peccing guide (GH-119232) (#119284)

gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232)

* Remove description of issue fixed in 3.5 from autospeccing guide

* Make autospeccing note text more succint and lint whitespace

* Add linting changes (missed in last commit)

---------

(cherry picked from commit 7e57640)

Co-authored-by: Shauna <shaunagm@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
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 skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inappropriateness in unittest documentation with actual behavior
3 participants