Fix doctest runable examples in python manual

Open
#54,434 23 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Review the existing issue10225-r27.diff, issue10225a-r27.diff, sorting-howto.diff, and issue10225-py3k.diff patches, then inspect the runnable examples in the Python manual they address. Compare the examples with the linked PRs gh-111677 through gh-111680. Done means the manual's doctest examples run successfully for the relevant Python documentation versions.

Written by the indexing model from the issue text.

Description

docs
BPO 10225
Nosy @birkenfeld, @rhettinger, @terryjreedy, @abalkin, @ezio-melotti, @merwok, @ambv, @andy-maier
Dependencies
  • bpo-10224: Build 3.x documentation using python3.x
    		•
    Files
  • issue10225-r27.diff: Patch agains 2.7 branch
  • issue10225a-r27.diff: Patch against 2.7 branch
  • sorting-howto.diff
  • issue10225-py3k.diff
    		•

    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 2010-10-29.02:18:53.672>
labels = ['docs']
title = 'Fix doctest runable examples in python manual'
updated_at = <Date 2016-07-16.01:27:06.527>
user = 'https://github.com/abalkin'

    bugs.python.org fields:

    activity = <Date 2016-07-16.01:27:06.527>
actor = 'belopolsky'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2010-10-29.02:18:53.672>
creator = 'belopolsky'
dependencies = ['10224']
files = ['19409', '19413', '20359', '20377']
hgrepos = []
issue_num = 10225
keywords = ['patch']
message_count = 21.0
messages = ['119840', '119841', '119842', '119869', '119908', '119917', '125860', '125906', '126050', '126051', '126063', '126067', '126073', '126074', '126107', '126111', '131794', '132019', '132020', '222164', '226121']
nosy_count = 9.0
nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'belopolsky', 'ezio.melotti', 'eric.araujo', 'docs@python', 'lukasz.langa', 'andymaier']
pr_nums = []
priority = 'normal'
resolution = 'accepted'
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue10225'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

    Linked PRs
    • gh-111677
    • gh-111678
    • gh-111679
    • gh-111680
    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.