python / python/cpython

lzma documentation: example to XZ compress file on disk

Open
#76,341 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 32160
Nosy @dhimmel

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 2017-11-28.20:41:15.049>
labels = ['3.8', 'type-feature', '3.7', 'expert-IO', 'docs']
title = 'lzma documentation: example to XZ compress file on disk'
updated_at = <Date 2017-11-28.20:50:25.989>
user = 'https://github.com/dhimmel'

bugs.python.org fields:

activity = <Date 2017-11-28.20:50:25.989>
actor = 'dhimmel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'IO']
creation = <Date 2017-11-28.20:41:15.049>
creator = 'dhimmel'
dependencies = []
files = []
hgrepos = []
issue_num = 32160
keywords = []
message_count = 2.0
messages = ['307163', '307166']
nosy_count = 2.0
nosy_names = ['docs@python', 'dhimmel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32160'
versions = ['Python 3.7', 'Python 3.8']

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.

Research direction

Start by locating the lzma documentation and its file-compression examples. Add an example showing how to XZ-compress a file on disk, and confirm the documentation clearly demonstrates that workflow.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.