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.

Sign up for GitHub

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

Jump to bottom

[doc] Fix padding in some typing definitions #22114

Merged
merged 1 commit into from
Sep 5, 2020
Merged

[doc] Fix padding in some typing definitions #22114

merged 1 commit into from
Sep 5, 2020

Conversation

andresdelfino
Copy link
Contributor

@andresdelfino andresdelfino commented Sep 5, 2020 •
edited by miss-islington
Loading

Automerge-Triggered-By: @gvanrossum

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Sep 5, 2020
gvanrossum
gvanrossum reviewed Sep 5, 2020
View reviewed changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

What does this fix?

@andresdelfino
Copy link
Contributor Author

@gvanrossum compare the definition of AbstractSet and ByteString. You'll see how the AbstractSet paragraph has an incorrect padding, because of the additional space in the RST.

@andresdelfino
Copy link
Contributor Author

Check the definition in the actual rendered documentation: https://docs.python.org/3.10/library/typing.html

@gvanrossum
Copy link
Member

Check the definition in the actual rendered documentation: https://docs.python.org/3.10/library/typing.html

Gotcha! Now I see. Will land once tests pass.

gvanrossum
gvanrossum approved these changes Sep 5, 2020
View reviewed changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks!

@miss-islington miss-islington merged commit 2623868 into python:master Sep 5, 2020
@miss-islington
Copy link
Contributor

Thanks @andresdelfino for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-22115 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Sep 5, 2020
@miss-islington
Copy link
Contributor

Sorry, @andresdelfino, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2623868ede4ef3c848fc83a9b1e19e0d031dee1d 3.8

@miss-islington miss-islington self-assigned this Sep 5, 2020
@gvanrossum
Copy link
Member

Can you take care of the backport to 3.8? AFAIK these docs are nearly the same on 3.8-3.10, but there are occasional differences that throw off the auto-backport.

@andresdelfino andresdelfino deleted the fix_typing_padding branch September 5, 2020 23:47
@andresdelfino
Copy link
Contributor Author

Sure!

@andresdelfino
Copy link
Contributor Author

@gvanrossum 3.8 doesn't have the problem. I think we can remove the "needs backport to 3.8" label.

miss-islington added a commit that referenced this pull request Sep 6, 2020
@miss-islington @andresdelfino
[3.9] [doc] Fix padding in some typing definitions (GH-22114) (GH-22115)
e4b359d 
Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 2623868)


Co-authored-by: Andre Delfino <adelfino@gmail.com>
shihai1991 added a commit to shihai1991/cpython that referenced this pull request Sep 10, 2020
@shihai1991
Merge remote-tracking branch 'origin/master' into bpo_1635741_1
00b300c 
* origin/master: (1373 commits)
  bpo-1635741: Port mashal module to multi-phase init (python#22149)
  bpo-1635741: Port _string module to multi-phase init (pythonGH-22148)
  bpo-1635741: Convert _sha256 types to heap types (pythonGH-22134)
  bpo-1635741: Port the termios to multi-phase init (PEP 489) (pythonGH-22139)
  bpo-41732: add iterator to memoryview (pythonGH-22119)
  bpo-40744: Drop support for SQLite pre 3.7.3 (pythonGH-20909)
  bpo-41316: Make tarfile follow specs for FNAME (pythonGH-21511)
  bpo-41720: Add "return NotImplemented" in turtle.Vec2D.__rmul__(). (pythonGH-22092)
  bpo-1635741 port _curses_panel to multi-phase init (PEP 489) (pythonGH-21986)
  bpo-1635741: Port _overlapped module to multi-phase init (pythonGH-22051)
  bpo-1635741: Port _opcode module to multi-phase init (PEP 489) (pythonGH-22050)
  bpo-1635741 port zlib module to multi-phase init (pythonGH-21995)
  [doc] Add link to Generic in typing (pythonGH-22125)
  bpo-41513: Expand comments and add references for a better understanding (pythonGH-22123)
  bpo-1635741: Port _sha1, _sha512, _md5 to multiphase init (pythonGH-21818)
  closes bpo-41723: Fix an error in the py_compile documentation. (pythonGH-22110)
  [doc] Fix padding in some typing definitions (pythonGH-22114)
  Fix documented Python version for venv --upgrade-deps (pythonGH-22113)
  bpo-40318: Migrate to SQLite3 trace v2 API (pythonGH-19581)
  bpo-41687: Fix sendfile implementation to work with Solaris (python#22040)
  ...
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
@andresdelfino
[doc] Fix padding in some typing definitions (pythonGH-22114)
2389c4c 
Automerge-Triggered-By: @gvanrossum
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gvanrossum gvanrossum gvanrossum approved these changes

@ilevkivskyi ilevkivskyi Awaiting requested review from ilevkivskyi

Assignees

@miss-islington miss-islington

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@andresdelfino @gvanrossum @miss-islington @bedevere-bot @the-knights-who-say-ni