faircode benchmark --root and --no-plots are not documented in the README or SPEC
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 87/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Leggi la sezione sui benchmark intorno alla riga 1135 di README.md, faircode/SPEC.md, il parser dei benchmark in faircode/cli.py e il test del parser dei comandi del README in tests/test_cli.py. Verifica dalla guida della CLI come si comportano --root e --no-plots, quindi documenta entrambi i flag in README e SPEC ed estendi il test per controllare le opzioni lunghe nei vari sottocomandi. Il lavoro è completato quando i flag sono documentati e il test passa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Where: README.md (the benchmark section around line 1135), faircode/SPEC.md, faircode/cli.py (benchmark parser), tests/test_cli.py (the README-command parser test, #948).
Current gap: every profile and compare flag appears in the README or SPEC, but faircode benchmark --root PATH (where */audit.yaml is searched) and --no-plots (skip matplotlib, so the command works without the plotting extra) appear only in --help. A reader of the README cannot learn that the harness can run outside the repository root or without matplotlib.
Repro:
$ python3 - <<'E'
from faircode.cli import build_parser
readme = open("README.md", encoding="utf-8").read() + open("faircode/SPEC.md", encoding="utf-8").read()
for name, sub in build_parser()._subparsers._group_actions[0].choices.items():
for action in sub._actions:
for option in action.option_strings:
if option.startswith("--") and option != "--help" and option not in readme: print(name, option)
E
benchmark --root
benchmark --no-plots
Suggested approach: add both flags to the README benchmark examples and SPEC, and extend the README-command test with a check that every long option of every subcommand is mentioned somewhere in README or SPEC.
- Lingua principale
- HTML
- Stelle
- 47
- Fork
- 45
- Merge medio
- 3h 15m
- PR unite (30g)
- 92
Preparare l'ambiente
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di yakew7/Fair-Code
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 57/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement help wanted
Difficoltà 3/5 1-2 giorni Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement help wanted
Difficoltà 3/5 1-2 giorni Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di yakew7/Fair-Code
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
I maintainer di solito rispondono entro 1 giorno
-
[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 cycles are false positivesAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
githubnext/gh-aw-workshop#4943 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Awaiting Triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
自荐：apkgo（多应用商店上架 / 发布 CLI）Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100