jj-vcs/jj

docs: Add graph to more JJ command help

Open

#3,687 创建于 2024年5月14日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Rust (28,830 star) (1,052 fork)batch import
documentation 📖good first issue

描述

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

贡献者指南

技术栈
rust
领域
clidocumentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Rust programming basicsjj codebase familiarityunderstanding of existing graph examples
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Examine the source code for how the help graph for `jj next` is generated, likely in the command implementation. Identify the functions or modules that produce the graph. Then, for commands like `jj interdiff` that deal with multiple revisions, add a similar graph by following the same pattern. Check the existing CLI reference to ensure consistency.