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

bpo-46586: Fix documentation links #31216

Merged
merged 4 commits into from
Feb 12, 2022
Merged

Conversation

meersuri
Copy link
Contributor

@meersuri meersuri commented Feb 8, 2022

Incorrectly pointed to built-in the property() function as mentioned in #46586

https://bugs.python.org/issue46586

Incorrectly pointed to built-in the property() function as mentioned in python#46586
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@meersuri

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@ethanfurman ethanfurman changed the title bpo-46586: Fix enum.property documentation link bpo-46586: Fix documentation links Feb 10, 2022
@@ -545,15 +545,15 @@ always available.
| :const:`mant_dig` | DBL_MANT_DIG | float precision: the number of base-``radix`` |
| | | digits in the significand of a float |
+---------------------+----------------+--------------------------------------------------+
| :const:`max` | DBL_MAX | maximum representable positive finite float |
| :const:`!max` | DBL_MAX | maximum representable positive finite float |
Copy link
Member

Choose a reason for hiding this comment

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

I think this is better done in a separate PR, so we can backport to the other bugfix branches.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see, so I guess that will require opening another issue and then the corresponding PR? Should I revert this commit here then?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, revert the commit here. It doesn't need an issue; trivial docs fixes don't need an issue. You can just attach the second PR to the same issue.

Copy link
Member

Choose a reason for hiding this comment

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

Also, based on @zware's comment on the bug, it's going to be better to change these to just put max in double backticks, since they aren't supposed to link anywhere.

Copy link
Member

Choose a reason for hiding this comment

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

That comment was @merwok, not me 😉. I agree with him, though.

Copy link
Member

Choose a reason for hiding this comment

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

Oops, sorry!

@@ -0,0 +1 @@
Fix enum.property link to point to the enum page rather than the built-in property() page
Copy link
Member

Choose a reason for hiding this comment

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

Not sure this needs a NEWS entry at all.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah sorry about that, I used blurb-it for the first time and by the time I was done, I saw that the skip-news label had been added. Should I just make another commit to remove this file?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, please!

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.

6 participants