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

Fix link to 'The Perils of Floating Point', on the tutorial #112499

Merged
merged 2 commits into from
Dec 3, 2023

Conversation

aureliobarbosa
Copy link
Contributor

@aureliobarbosa aureliobarbosa commented Nov 28, 2023

CPython Tutorial "15. Floating Point Arithmetic: Issues and Limitations" links to the document "The Perils of Floating Point", which was written by Bruce M. Bush in 1996, while working for Lahey Software Solutions. The document was hosted by this company, which ceased its activity last year. Fortunately, a copy of the document was kept by by Emeritus professor Brian Junker, from Carnegie Mellon University, which is the document I am linking to right now.

The document provide details on how floating point numbers are represented on computer systems and it should be interesting to keep this reference.


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

Copy link

cpython-cla-bot bot commented Nov 28, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Nov 28, 2023
@serhiy-storchaka
Copy link
Member

How can we know that this is a legal copy of the document?

@serhiy-storchaka
Copy link
Member

BTW, the last snapshot of this document on the Web Archive is http://web.archive.org/web/20230604072523/http://www.lahey.com/float.htm .

@aureliobarbosa
Copy link
Contributor Author

aureliobarbosa commented Nov 29, 2023

How can we know that this is a legal copy of the document?

Thanks for the comment and feedback. Further investigation led to find that the author Bruce M. Bush currently hosts a copy of document on his own professional site, through this link. He also grants permission to share the document, but asks to acknowledge the source propertly:

"The Perils of Floating Point by Bruce M. Bush © 1996 Lahey Computer Systems, Inc."

I think it's better to use the new link but about citation, I am not sure whether a company (even a closed one), and an author, should be cited on the python documentation. Personally, I would follow the author, but give me a direction and I follow according the community standard in a new commit.

@serhiy-storchaka
Copy link
Member

I think a link should be enough. We do not copy the document, we only provide a link to the original document that contains all necessary copyright information. Everyone who read the document has also access to this information.

@aureliobarbosa
Copy link
Contributor Author

Thanks @serhiy-storchaka.

@serhiy-storchaka serhiy-storchaka merged commit c27b09c into python:main Dec 3, 2023
26 checks passed
@serhiy-storchaka serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Dec 3, 2023
@miss-islington-app
Copy link

Thanks @aureliobarbosa for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington-app
Copy link

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

@bedevere-app
Copy link

bedevere-app bot commented Dec 3, 2023

GH-112663 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
…-112499)

Use author link to 'The Perils of Floating Point'.
(cherry picked from commit c27b09c)

Co-authored-by: Marco Aurélio A. Barbosa <aureliobarbosa@gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Dec 3, 2023
@bedevere-app
Copy link

bedevere-app bot commented Dec 3, 2023

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
…-112499)

Use author link to 'The Perils of Floating Point'.
(cherry picked from commit c27b09c)

Co-authored-by: Marco Aurélio A. Barbosa <aureliobarbosa@gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Dec 3, 2023
@serhiy-storchaka
Copy link
Member

Thank you for your contribution @aureliobarbosa.

serhiy-storchaka pushed a commit that referenced this pull request Dec 3, 2023
…H-112499) (GH-112664)

Use author link to 'The Perils of Floating Point'.
(cherry picked from commit c27b09c)

Co-authored-by: Marco Aurélio A. Barbosa <aureliobarbosa@gmail.com>
serhiy-storchaka pushed a commit that referenced this pull request Dec 3, 2023
…H-112499) (GH-112663)

Use author link to 'The Perils of Floating Point'.
(cherry picked from commit c27b09c)

Co-authored-by: Marco Aurélio A. Barbosa <aureliobarbosa@gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@aureliobarbosa aureliobarbosa deleted the fix-tutorial-float_ref branch March 5, 2024 11:56
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants