Skip to content

bpo-45391: mark UnionType as a class in documentation#28757

Merged
Fidget-Spinner merged 1 commit into
python:mainfrom
gaborbernat:45391
Dec 9, 2021
Merged

bpo-45391: mark UnionType as a class in documentation#28757
Fidget-Spinner merged 1 commit into
python:mainfrom
gaborbernat:45391

Conversation

@gaborbernat
Copy link
Copy Markdown
Contributor

@gaborbernat gaborbernat commented Oct 6, 2021

❯ sphobjinv suggest ./build/html/objects.inv UnionType
:py:class:`types.UnionType`

Signed-off-by: Bernát Gábor bgabor8@bloomberg.net

https://bugs.python.org/issue45391

Things to consider the type does show up as class now in documentation:
Screenshot 2021-10-06 at 13 43 14
vs before
Screenshot 2021-10-06 at 13 44 36

This PR only addresses the instance in the issue report, but we should discuss if we should change all such instances in this file (there are quite a few others suffering from the same problem).

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 6, 2021

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

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Nov 6, 2021
@merwok merwok changed the title bpo-45391: UnionType is a class not data bpo-45391: make UnionType as a class in documentation Nov 6, 2021
@merwok merwok changed the title bpo-45391: make UnionType as a class in documentation bpo-45391: mark UnionType as a class in documentation Nov 6, 2021
Copy link
Copy Markdown
Member

@Fidget-Spinner Fidget-Spinner left a comment

Choose a reason for hiding this comment

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

I'm merging this as this is more straightforward than the rest of the list mentioned on the bpo. Those need more deliberation.

@Fidget-Spinner Fidget-Spinner merged commit e2cfc89 into python:main Dec 9, 2021
@miss-islington
Copy link
Copy Markdown
Contributor

Thanks @gaborbernat for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 9, 2021
Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
(cherry picked from commit e2cfc89)

Co-authored-by: Bernát Gábor <gaborjbernat@gmail.com>
@bedevere-bot
Copy link
Copy Markdown

GH-30004 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Dec 9, 2021
@Fidget-Spinner
Copy link
Copy Markdown
Member

Thanks @gaborbernat for catching this, and thank you @AlexWaygood for reminding me to check this PR.

miss-islington added a commit that referenced this pull request Dec 9, 2021
Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
(cherry picked from commit e2cfc89)

Co-authored-by: Bernát Gábor <gaborjbernat@gmail.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 stale Stale PR or inactive for long period of time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants