-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Illustrate --revision
argument variations using Git diagrams
#326
Labels
documentation
Improvements or additions to documentation
Milestone
Comments
Moving this later. |
Seems that gitGraph works in GitHub (see e.g. mermaid-js documentation) even though it is still experimental. So we could in fact go forward with this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
-r
/--revision
argument has a number of features which are not intuitively easy to understand, including at least:rev1..rev2
)rev1...rev2
)rev2
)..rev2
and...rev2
)rev1..
andrev1...
)rev1...:WORKTREE:
)HEAD
(e.g.rev1...HEAD
):PRE-COMMIT:
)While the features are explained in the documentation, they would be much better communicated by using Git history diagrams along with the explanations – or perhaps common use cases and corresponding Git diagrams in a table.
GitHub supports Mermaid, and Mermaid does have experimental support for Git graphs:
Not sure if this particular Mermaid feature is supported in GitHub yet, though.It is. See comment below.On the other hand, Mermaid doesn't probably render as easily on PyPI, or might turn out to generate less than satisfactory output. And we do have a plan to convert the README to proper Sphinx based documentation and publish it e.g. on Read the Docs (see #78), and for that there's sphinxcontrib-mermaid.
The text was updated successfully, but these errors were encountered: