python / python/devguide

Add steps needed to run a basic performance test in benchmarks

Aperta
#187 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

topic-test type-feature
Lingua principale
Python
Stelle
2.1k
Fork
1k
Merge medio
2g 12h
PR unite (30g)
12

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla sezione benchmarks di runtests.rst e consulta il README.txt di pyperformance per i comandi e le opzioni utilizzati con compare_to. Aggiungi una breve sezione “come confrontare tra commit” con i comandi minimi e un link alla documentazione sulle performance. Il lavoro è completato quando i contributori possono iniziare un confronto senza dover scoprire da soli la sequenza di comandi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.