python / python/cpython

Tutorial links to file object methods are broken.

Open
#73,361 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs easy type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 29175
Nosy @birkenfeld, @ezio-melotti, @merwok, @bitdancer, @JonathanRoach

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 2017-01-06.09:58:43.773>
labels = ['type-bug', '3.7', 'docs']
title = 'Tutorial links to file object methods are broken.'
updated_at = <Date 2017-01-06.20:47:31.474>
user = 'https://github.com/JonathanRoach'

bugs.python.org fields:

activity = <Date 2017-01-06.20:47:31.474>
actor = 'jonroach@icloud.com'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-01-06.09:58:43.773>
creator = 'jonroach@icloud.com'
dependencies = []
files = []
hgrepos = []
issue_num = 29175
keywords = []
message_count = 3.0
messages = ['284806', '284825', '284848']
nosy_count = 6.0
nosy_names = ['georg.brandl', 'ezio.melotti', 'eric.araujo', 'r.david.murray', 'docs@python', 'jonroach@icloud.com']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue29175'
versions = ['Python 3.6', 'Python 3.7']

Linked PRs
  • gh-138863

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.

Research direction

Start by reviewing the tutorial links to file object methods and the linked pull request gh-138863, since the issue provides no file path. Check which links no longer resolve and compare the proposed changes in the pull request. Done means the affected tutorial links point to valid file-object method documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.