Docs style guide: Code Examples, distinguish between the Tutorial and other documentation

Open

#1,627 opened on May 24, 2020 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 4/5
Estimated time: 3-5 days
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: python
Domain: documentation

Research direction

The payload names no repository file or test; begin by locating the devguide's documentation style guide and its guidance for Tutorial code examples. Read the linked BPO issue for the intended distinction, then update the relevant documentation so Tutorial examples are clearly treated separately from other documentation.

Written by the indexing model from the issue text.

Description

needs: decision topic-documentation type-feature

BPO	40758
Nosy	@rhettinger, @ChasBelov

^{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-05-24.20:49:25.128>
labels = ['3.8', '3.9', '3.10', 'docs']
title = 'For 7.2.7. Code Examples, distinguish between the Tutorial and other documentation'
updated_at = <Date 2021-03-26.03:23:38.984>
user = 'https://github.com/ChasBelov'

bugs.python.org fields:

activity = <Date 2021-03-26.03:23:38.984>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-05-24.20:49:25.128>
creator = 'Chas Belov'
dependencies = []
files = []
hgrepos = []
issue_num = 40758
keywords = []
message_count = 2.0
messages = ['369825', '389537']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'Chas Belov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40758'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Dominant language: Python
Stars: 2.1k
Forks: 1k
Avg merge: 2d 12h
Merged PRs (30d): 12

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

create_predictable_zip member order differs on Windows for directory input Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 90/100

learningequality/ricecooker#747 · Opened Sep 23, 2026
[Anon] Mechanicum: skitarii as mechanicum allies rule Open

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

BSData/horus-heresy-3rd-edition#3171 · Opened Sep 23, 2026
CHANGELOG.md entries are too long to maintain, and their length is what makes every PR conflict expensive Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 72/100

lanl/PyBNF#809 · Opened Sep 23, 2026
[Bug]: PrevNextNodePostprocessor loses retrieved scores when neighbor windows overlap Open

Difficulty 2/5 1-3 hours Newbie friendliness 76/100

run-llama/llama_index#23199 · Opened Sep 23, 2026
Cannot export point cloud without radius attribute Open

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

KhronosGroup/glTF-Blender-IO#2769 · Opened Sep 23, 2026

More Python issues