Clearly document the use of PYTHONIOENCODING to set surrogateescape

Open
#62,913 34 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the superseding bpo-12832 issue and the linked surrogateescape.patch, then review the historical discussion for the intended documentation scope. Confirm whether the work remains needed; done means clearly documenting how PYTHONIOENCODING controls surrogateescape without duplicating the superseding issue.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 18713
Nosy @malemburg, @ncoghlan, @pitrou, @vstinner, @benjaminp, @ezio-melotti, @abadger, @bitdancer, @serhiy-storchaka
Dependencies
  • bpo-18818: Empty PYTHONIOENCODING is not the same as nonexistent
    		•
    Superseder
  • bpo-12832: The documentation for the print function should explain/point to how to control the sys.stdout encoding
    		•
    Files
  • surrogateescape.patch
    		•

    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 2013-08-12.15:19:33.999>
labels = ['type-feature', 'docs']
title = 'Clearly document the use of PYTHONIOENCODING to set surrogateescape'
updated_at = <Date 2017-03-24.16:29:59.624>
user = 'https://github.com/ncoghlan'

    bugs.python.org fields:

    activity = <Date 2017-03-24.16:29:59.624>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2013-08-12.15:19:33.999>
creator = 'ncoghlan'
dependencies = ['18818']
files = ['31414']
hgrepos = []
issue_num = 18713
keywords = ['patch']
message_count = 34.0
messages = ['194968', '194969', '194970', '195732', '195733', '195734', '195735', '195741', '195746', '195761', '195769', '195844', '195860', '195862', '195866', '195867', '195868', '195870', '195871', '195872', '195873', '195874', '195878', '195882', '195886', '195894', '195897', '195908', '195929', '195931', '195932', '195938', '195966', '242618']
nosy_count = 13.0
nosy_names = ['lemburg', 'ncoghlan', 'pitrou', 'vstinner', 'abadger1999', 'benjamin.peterson', 'ezio.melotti', 'a.badger', 'Arfrever', 'r.david.murray', 'nikratio', 'docs@python', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'needs patch'
status = 'pending'
superseder = '12832'
type = 'enhancement'
url = 'https://bugs.python.org/issue18713'
versions = ['Python 3.4']

    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.