mirror of
https://github.com/martinvonz/jj.git
synced 2025-02-01 00:50:57 +00:00
ed84468cb8
We're scraping the CLI help text and rendering it as markdown, so we can use an "admonition" to have this warning text render nicer in the web documentation. You could argue that `!!! warning` is a little weird to see on the CLI. Some alternatives: - We could opt to not design the CLI help text around markdown and skip the change to the `jj util exec` help in this commit. - We could adopt some kind of format that can be rendered well in both contexts. - Could sticking to specific formatting constructs by convention. - Could use/create an actual translation tool from CLI format to Markdwon. - We could keep separate versions of web and CLI documentation. (Seems like a bad idea for the foreseeable future, because we don't have the resources to constantly keep both up-to-date and sync.) I'm in favor of just writing Markdown in the CLI help text for now. |
||
---|---|---|
.. | ||
examples | ||
src | ||
testing | ||
tests | ||
build.rs | ||
Cargo.toml | ||
docs | ||
LICENSE |