jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3.687 aberto em 14 de mai. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1.052 forks)batch import
documentation 📖good first issue

Métricas do repositório

Stars
 (28.830 stars)
Métricas de merge de PR
 (Mesclagem média 23d 5h) (46 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Examine o código fonte de como o gráfico de ajuda para `jj next` é gerado, provavelmente na implementação do comando. Identifique as funções ou módulos que produzem o gráfico. Em seguida, para comandos como `jj interdiff` que lidam com múltiplas revisões, adicione um gráfico semelhante seguindo o mesmo padrão. Verifique a referência da CLI existente para garantir consistência.
Pilha de tecnologia
rust
Domain
clidocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70