[doc] State clearly that open() 'file' param is "name" attr of the result

Open
#62,734 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the documentation for open() and review linked PR gh-144455, since the issue does not name a documentation file. The work is done when the documentation clearly states that the file parameter is the name attribute of the returned result.

Written by the indexing model from the issue text.

Description

3.10 3.11 3.9 (EOL) docs easy
BPO 18534
Nosy @gvanrossum, @ncoghlan, @pitrou, @vstinner, @mitsuhiko, @serhiy-storchaka, @slateny

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 2013-07-23.05:06:58.278>
labels = ['easy', '3.11', '3.9', '3.10', 'docs']
title = '[doc] State clearly that open() \'file\' param is "name" attr of the result'
updated_at = <Date 2022-03-01.10:09:16.050>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2022-03-01.10:09:16.050>
actor = 'slateny'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2013-07-23.05:06:58.278>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 18534
keywords = ['easy']
message_count = 7.0
messages = ['193585', '193602', '193616', '193625', '193695', '305354', '414254']
nosy_count = 8.0
nosy_names = ['gvanrossum', 'ncoghlan', 'pitrou', 'vstinner', 'aronacher', 'docs@python', 'serhiy.storchaka', 'slateny']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue18534'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

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