ConfigParser.get() doc to be updated according to the configparser.py header doc

Open
#70,282 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start in configparser.py and compare the ConfigParser.get() documentation with the module header documentation. Update the method documentation so it reflects the header's description, then verify that the resulting text is consistent with the surrounding ConfigParser API documentation.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 26094
Nosy @freddrake, @vadmium, @khyox

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 2016-01-13.00:39:59.664>
labels = ['type-feature', 'docs']
title = 'ConfigParser.get() doc to be updated according to the configparser.py header doc'
updated_at = <Date 2016-01-15.22:49:23.043>
user = 'https://github.com/khyox'

bugs.python.org fields:

activity = <Date 2016-01-15.22:49:23.043>
actor = 'martin.panter'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2016-01-13.00:39:59.664>
creator = 'khyox'
dependencies = []
files = []
hgrepos = []
issue_num = 26094
keywords = []
message_count = 2.0
messages = ['258124', '258337']
nosy_count = 4.0
nosy_names = ['fdrake', 'docs@python', 'martin.panter', 'khyox']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26094'
versions = ['Python 3.5', 'Python 3.6']

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.