jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3687 aperta il 14 mag 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Rust (1052 fork)batch import
documentation 📖good first issue

Metriche repository

Star
 (28.830 star)
Metriche merge PR
 (Merge medio 23g 5h) (46 PR mergiate in 30 g)

Descrizione

Description

Several JJ commands already have graphs to help understand them when in their long --help form, this is awesome!

I would like all JJ command working with graph of more than a single revision to have at least one of those.

Steps to Reproduce the Problem

  1. jj interdiff --help <- no graph

Expected Behavior

The current list of commands is at https://martinvonz.github.io/jj/v0.17.1/cli-reference/ and we can for example see jj next has a graph. This should be the standard whenever possible/relevant, since words alone are often confusing/not enough when talking about graphs

Guida contributor

Direzione di ricerca
Esamina il codice sorgente per capire come viene generato il grafico di aiuto per `jj next`, probabilmente nell'implementazione del comando. Identifica le funzioni o i moduli che producono il grafico. Quindi, per comandi come `jj interdiff` che gestiscono più revisioni, aggiungi un grafico simile seguendo lo stesso schema. Controlla il riferimento CLI esistente per garantire coerenza.
Tech stack
rust
Dominio
clidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70