python / python/devguide

Add steps needed to run a basic performance test in benchmarks

Open
#187 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It would be a nice addition to the devguide if the benchmarks section of runtests.rst contained the minimal commands needed to run pyperformance for comparing the potential performance diffs introduced by a change a user performed. Usually when a performance issue arises, the result of compare_to is posted for others to examine.

Specifically, if possible, a small section of the form "how to compare between commits" and with what options set would be ideal. Because pyperformance takes a considerable amount of time to finish, getting the right commands from the start would save people (myself included :-) quite some time.

Though it might be argued that this should go in the docs for performance I think having a small set of commands in the devguide with a see more pointing to the README.txt of the repo might be better.

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 benchmarks section of runtests.rst and review the pyperformance README.txt for the commands and options used with compare_to. Add a short “how to compare between commits” section with the minimal commands and a link to the performance documentation. Done means contributors can begin a comparison without needing to discover the command sequence themselves.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.