Docs: More description(warning) about LZMA1 + BCJ with FORMAT_RAW

Open
#85,382 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the linked lzmabcj.bin test data and the two historical 0001-lzma-support-LZMA1-with-FORMAT_RAW.patch files first. Confirm the relevant documentation and test coverage for LZMA1 with BCJ and FORMAT_RAW, then update the warning so the limitation is clearly described and the reproduction remains covered.

Written by the indexing model from the issue text.

Description

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) stdlib
BPO 41210
Nosy @animalize, @miurahr, @Game
Files
  • lzmabcj.bin: test data to reproduce a problem
  • 0001-lzma-support-LZMA1-with-FORMAT_RAW.patch: add test and update doc
  • 0001-lzma-support-LZMA1-with-FORMAT_RAW.patch: Add tests and update doc
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = None
    created_at = <Date 2020-07-05.01:51:25.905>
    labels = ['3.8', '3.7', 'library', '3.9']
    title = 'Docs: More description(warning) about LZMA1 + BCJ with FORMAT_RAW'
    updated_at = <Date 2022-03-21.23:05:00.696>
    user = 'https://github.com/miurahr'
    

    bugs.python.org fields:

    activity = <Date 2022-03-21.23:05:00.696>
    actor = 'ned.deily'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2020-07-05.01:51:25.905>
    creator = 'miurahr'
    dependencies = []
    files = ['49296', '49300', '49301']
    hgrepos = []
    issue_num = 41210
    keywords = ['patch']
    message_count = 11.0
    messages = ['373008', '373086', '373199', '373206', '373208', '373210', '373519', '373581', '373590', '373591', '374715']
    nosy_count = 4.0
    nosy_names = ['malin', 'miurahr', 'Janae147', 'blogavoid']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue41210'
    versions = ['Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9']
    

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.