docs: add fish_jj_prompt documentation - #12758
Open
abhayjnayakk wants to merge 1 commit into
Open
Conversation
Document fish_jj_prompt alongside the other VCS prompt helpers so it appears in the command index and prompt guide. Fixes fish-shell#12756 Co-authored-by: Cursor <cursoragent@cursor.com>
krobelus
reviewed
May 24, 2026
| Description | ||
| ----------- | ||
|
|
||
| The ``fish_jj_prompt`` function displays information about the current Jujutsu repository, if any. |
Contributor
There was a problem hiding this comment.
Jujutsu
need a link to explain what this is, like for example fish_git_prompt.rst links to https://git-scm.com
|
|
||
| The ``fish_jj_prompt`` function displays information about the current Jujutsu repository, if any. | ||
|
|
||
| It currently reports whether the working copy commit has conflicts. |
Contributor
There was a problem hiding this comment.
currently
maybe drop this word?
|
|
||
| If ``jj`` is not installed, or the current directory is not in a Jujutsu repository, ``fish_jj_prompt`` returns 1 and prints nothing. | ||
|
|
||
| See also :doc:`fish_vcs_prompt <fish_vcs_prompt>`, which will call all supported version control prompt functions, including Jujutsu, git and Mercurial. |
Contributor
There was a problem hiding this comment.
the "including" line is out of sync with fish_git_prompt and others
| See also :doc:`fish_vcs_prompt <fish_vcs_prompt>`, which will call all supported version control prompt functions, including Jujutsu, git and Mercurial. | ||
|
|
||
| Example | ||
| ------- |
Contributor
There was a problem hiding this comment.
Could not run the full Sphinx docs build locally because Sphinx is not installed in this environment.
if you want to use uv, you can use uv run cargo xtask html-docs and uv run cargo xtask check etc.
| A simple prompt that displays Jujutsu information:: | ||
|
|
||
| function fish_prompt | ||
| printf '%s %s$' $PWD (fish_jj_prompt) |
Contributor
There was a problem hiding this comment.
these examples don't seem good because fish_jj_prompt is usually an empty list, so we get a weird trailing space
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
fish_jj_prompt.fish_vcs_promptdocs, and prompt guide.Fixes #12756
Testing
Made with Cursor