python / python/devguide

Idea: mention 3rd party "extended stdlib" modules in developer guide

Open
#35 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-dev process type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

We have a section in the developer guide specifically on proposing changes to the standard library: http://cpython-devguide.readthedocs.io/en/latest/stdlibchanges.html

One of the alternatives to standard library additions that frequently needs to be brought up on python-ideas is the possibility of adding to one of the "stdlib enhancement" projects that adds assorted general purpose programming utilities that are nevertheless considered sufficiently niche use cases that they don't make the cut for standard library inclusion (or, alternatively, folks want them now, rather than having to wait for a new CPython feature release)

Perhaps it would make sense to specifically mention some of those projects in this part of the developer guide? The main two that come to mind are:

There are probably others, but once we start the list, it's relatively easy to add new entries, but with no list at all, it's unlike anyone (else) would suggest adding one.

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 with the developer guide's standard-library changes section at stdlibchanges.html and review how alternative projects are currently described. Add mentions of boltons and more-itertools, preserving the section's existing style; done means the guide points readers to these projects as alternatives to standard-library additions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.