Dialect class defaults are not documented.

Open
#68,335 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the referenced csv_dialect_doc_clarify.patch and csv.html files, then locate the current CSV dialect documentation they were intended to clarify. Confirm that the dialect class defaults are documented and that the wording matches the existing documentation style; note that PR gh-96842 is already linked to this work.

Written by the indexing model from the issue text.

Description

3.10 docs easy type-bug
BPO 24147
Nosy @smontanaro, @bitdancer, @berkerpeksag, @iritkatriel, @uniocto
PRs
  • python/cpython#25989
    		•
    Files
  • sans_headers.csv
  • quotebug.py
  • csv_dialect_doc_clarify.patch: Document clarification
  • csv.html: html file holding the changes
    		•

    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 2015-05-09.01:05:19.126>
labels = ['easy', 'type-bug', '3.10', 'docs']
title = 'Dialect class defaults are not documented.'
updated_at = <Date 2021-05-08.12:32:59.244>
user = 'https://bugs.python.org/MiK'

    bugs.python.org fields:

    activity = <Date 2021-05-08.12:32:59.244>
actor = 'uniocto'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2015-05-09.01:05:19.126>
creator = 'MiK'
dependencies = []
files = ['39328', '39406', '39552', '39553']
hgrepos = []
issue_num = 24147
keywords = ['patch', 'easy']
message_count = 14.0
messages = ['242787', '242807', '242811', '242818', '243396', '243397', '243399', '243402', '244344', '244347', '244400', '244407', '389327', '393254']
nosy_count = 8.0
nosy_names = ['skip.montanaro', 'r.david.murray', 'docs@python', 'berker.peksag', 'jbmilam', 'MiK', 'iritkatriel', 'uniocto']
pr_nums = ['25989']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue24147'
versions = ['Python 3.10']

    Linked PRs
    • gh-96842
    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.