bpo-29557: Remove abiguous line in binhex docs by davidwilemski · Pull Request #90 · python/cpython (original) (raw)

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 andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation7 Commits1 Checks0 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

davidwilemski

"appears to not work in all cases" does not inspire confidence in this
module. I can find no context for what bug this was referencing so it
should be removed.

It appears this comment was from the original documentation for this function in 1995 but the commit also does not include any context regarding a bug: https://hg.python.org/cpython/rev/3911d4a89ab0#l4.40

"appears to not work in all cases" does not inspire confidence in this module. I can find no context for what bug this was referencing so it should be removed.

@davidwilemski

There was a bug fixed in the binhex function in 2009 but I have no idea if this was the bug that this documentation line was referring to: https://bugs.python.org/issue6369

I see no other open issues for binhex in the issue tracker so I believe this line should be removed until we have a concrete bug report that can be referenced by the documentation.

@codecov

Codecov Report

Merging #90 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@ Coverage Diff @@ ## master #90 +/- ##


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d50f188...0a8eecc. Read the comment docs.

berkerpeksag

Choose a reason for hiding this comment

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

Thanks for the PR! I think your analysis looks correct. However, it would be nice to record your research on bugs.python.org. Also, we can get more feedback from other core developers since not all of them subscribe to the GitHub repository.

See also step 5 at http://cpython-devguide.readthedocs.io/#quick-start

@davidwilemski

@davidwilemski davidwilemski changed the titleRemove abiguous line in binhex docs bpo-29557: Remove abiguous line in binhex docs

Feb 14, 2017

@zware

@davidwilemski Could you please add your GitHub username to your bpo profile?

@davidwilemski

berkerpeksag

@berkerpeksag

Mariatta referenced this pull request in Mariatta/cpython

Mar 5, 2017

@davidwilemski @Mariatta

"appears to not work in all cases" does not inspire confidence in this module. I can find no context for what bug this was referencing so it should be removed. (cherry picked from commit 6de2b78)

Mariatta referenced this pull request in Mariatta/cpython

Mar 5, 2017

@davidwilemski @Mariatta

"appears to not work in all cases" does not inspire confidence in this module. I can find no context for what bug this was referencing so it should be removed. (cherry picked from commit 6de2b78)

Mariatta added a commit that referenced this pull request

Mar 6, 2017

@Mariatta

"appears to not work in all cases" does not inspire confidence in this module. I can find no context for what bug this was referencing so it should be removed. (cherry picked from commit 6de2b78)

Mariatta added a commit that referenced this pull request

Mar 6, 2017

@Mariatta

"appears to not work in all cases" does not inspire confidence in this module. I can find no context for what bug this was referencing so it should be removed. (cherry picked from commit 6de2b78)

akruis pushed a commit to akruis/cpython that referenced this pull request

Sep 9, 2017

jaraco pushed a commit that referenced this pull request

Dec 2, 2022

@Mariatta

Update the readme indicating that the PR will be assigned to the core dev for follow up.

This was referenced

Feb 11, 2025