Would a section on performance be of interest?

Open
#1,110 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

The issue proposes adding a guide section on Python performance pitfalls, profiling, and benchmarking. No files, tests, or entry points are named, and the scope is posed as an open question; first review the guide's scope and structure, then define the section content and acceptance criteria before implementation.

Written by the indexing model from the issue text.

Description

I feel like a section on common performance pitfalls in Python could be highly useful, not only to new Python programmers but also as a reference for intermediate programmers and up.

Potentially such a section could also include tips on how to profile and/or benchmark Python code.

Would this fit within the scope of this guide?

Dominant language
Batchfile
Stars
29.8k
Forks
5.9k
PR merge metrics
No merged PRs in 30d

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 realpython/python-guide

All issues in realpython/python-guide

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.