Improve documentation of locale encoding functions

Open
#57,283 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the attached Issue13074.diff and the documentation for the locale encoding functions. Confirm where the note recommending getpreferredencoding belongs and update that documentation. Done means the recommendation is clearly documented in the appropriate locale encoding section.

Written by the indexing model from the issue text.

Description

docs pending
BPO 13074
Nosy @malemburg, @vstinner, @ezio-melotti, @merwok
Files
  • Issue13074.diff: Add note recommending getpreferredencoding
    		•

    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 2011-09-30.08:15:33.299>
labels = ['docs']
title = 'Improve documentation of locale encoding functions'
updated_at = <Date 2019-03-15.23:53:33.522>
user = 'https://bugs.python.org/gjb1002'

    bugs.python.org fields:

    activity = <Date 2019-03-15.23:53:33.522>
actor = 'BreamoreBoy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2011-09-30.08:15:33.299>
creator = 'gjb1002'
dependencies = []
files = ['35782']
hgrepos = []
issue_num = 13074
keywords = ['patch']
message_count = 3.0
messages = ['144677', '221582', '221596']
nosy_count = 6.0
nosy_names = ['lemburg', 'gjb1002', 'vstinner', 'ezio.melotti', 'eric.araujo', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue13074'
versions = ['Python 3.4', 'Python 3.5']

    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.