Skip to content

gh-92446: Fix Argparse and LZMACompressor Docs #94627

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

Merged
hauntsaninja merged 6 commits into from
Dec 26, 2022
Merged

gh-92446: Fix Argparse and LZMACompressor Docs #94627

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3e55685
Revert lzma documentation change
yourlefthandman Jul 6, 2022
956df83
Update the argparse documentation to refer to choices as a sequence
yourlefthandman Jul 6, 2022
3c512f1
Merge branch 'main' into fix_2_92446
yourlefthandman Jul 6, 2022
7ce0990
Merge branch 'main' into fix_2_92446
yourlefthandman Jul 7, 2022
917d4e9
Merge branch 'main' into fix_2_92446
yourlefthandman Jul 8, 2022
0e96c38
Say tuple instead of set
slateny Dec 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Revert lzma documentation change
  • Loading branch information
@yourlefthandman
yourlefthandman committed Jul 6, 2022
commit 3e55685c3a933fb18305078a5589231ca9dd1672
2 changes: 1 addition & 1 deletion Doc/library/lzma.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Compressing and decompressing data in memory
This format is more limited than ``.xz`` -- it does not support integrity
checks or multiple filters.

* :const:`FORMAT_RAW`: A raw data stream, not using sequences format.
* :const:`FORMAT_RAW`: A raw data stream, not using any container format.

@JelleZijlstra JelleZijlstra Sep 29, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't know what the motivation is for this change, and it doesn't seem related to the linked issue. Why is it needed?

@hauntsaninja hauntsaninja Oct 28, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It was (seemingly) mistakenly changed in https://github.com/python/cpython/pull/92450/files , a previous attempt to fix the issue

This format specifier does not support integrity checks, and requires that
you always specify a custom filter chain (for both compression and
decompression). Additionally, data compressed in this manner cannot be
Expand Down