python / python/cpython

Make 'rt' the default for open in docs

Open
#84,562 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 40382
Nosy @terryjreedy, @facundobatista

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 2020-04-24.20:16:00.259>
labels = ['type-feature', '3.9', 'docs']
title = "Make 'rt' the default for open in docs"
updated_at = <Date 2020-05-01.20:43:05.171>
user = 'https://github.com/facundobatista'

bugs.python.org fields:

activity = <Date 2020-05-01.20:43:05.171>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-04-24.20:16:00.259>
creator = 'facundobatista'
dependencies = []
files = []
hgrepos = []
issue_num = 40382
keywords = []
message_count = 2.0
messages = ['367219', '367885']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'facundobatista', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40382'
versions = ['Python 3.9']

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

Search the CPython documentation for references to open and its default mode, starting with the documentation source rather than implementation code. Update the relevant wording so the default is documented as 'rt', then verify that the affected documentation examples and API description are consistent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.