Doctest sees directives in strings when it should only see them in comments

Open
#56,118 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
testing

Research direction

Start by reviewing comments.diff, comments2.diff, and comments3.diff, the implementation artifacts named in the issue, then locate doctest’s directive parsing entry point. The change is done when directives inside strings are ignored while directives in comments are still recognized; run the relevant doctest tests to verify both cases.

Written by the indexing model from the issue text.

Description

stdlib type-feature
BPO 11909
Nosy @tim-one, @benjaminp, @ssbr, @bitdancer, @akheron
Files
  • comments.diff: patch to tip
  • comments2.diff
  • comments3.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 2011-04-22.19:31:22.132>
labels = ['type-feature', 'library']
title = 'Doctest sees directives in strings when it should only see them in comments'
updated_at = <Date 2011-07-04.03:45:34.894>
user = 'https://github.com/ssbr'

    bugs.python.org fields:

    activity = <Date 2011-07-04.03:45:34.894>
actor = 'Devin Jeanpierre'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2011-04-22.19:31:22.132>
creator = 'Devin Jeanpierre'
dependencies = []
files = ['21757', '22559', '22562']
hgrepos = []
issue_num = 11909
keywords = ['patch']
message_count = 8.0
messages = ['134278', '138780', '138886', '138893', '138948', '139715', '139721', '139732']
nosy_count = 5.0
nosy_names = ['tim.peters', 'benjamin.peterson', 'Devin Jeanpierre', 'r.david.murray', 'petri.lehtinen']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue11909'
versions = ['Python 3.3']

    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.