Skip to content
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

docs CLI Reference: upgrade clap-markdown to 0.1.4 (fixes important bugs) #3891

Merged
merged 4 commits into from
Jun 16, 2024

Conversation

ilyagr
Copy link
Contributor

@ilyagr ilyagr commented Jun 15, 2024

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added tests to cover my changes

@ilyagr ilyagr changed the title docs: upgrade clap-markdown (fixes important bugs) docs: upgrade clap-markdown to 0.1.4 (fixes important bugs) Jun 15, 2024
@ilyagr ilyagr force-pushed the clap-markdown-new branch 2 times, most recently from 35d5c52 to 11b63b7 Compare June 15, 2024 22:04
@ilyagr ilyagr marked this pull request as ready for review June 15, 2024 22:15
@ilyagr ilyagr changed the title docs: upgrade clap-markdown to 0.1.4 (fixes important bugs) docs CLI Reference: upgrade clap-markdown to 0.1.4 (fixes important bugs) Jun 15, 2024
Copy link
Member

@thoughtpolice thoughtpolice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, the reference looks much better!

@ilyagr
Copy link
Contributor Author

ilyagr commented Jun 15, 2024

There are a few new (and old) imperfections, I might fix them in a separate PR since it involves changing the docstrings:

image

More, for future reference

image

image

@ilyagr
Copy link
Contributor Author

ilyagr commented Jun 15, 2024

I will wait for a few hours before merging, in case anyone has comments (or wants me to wait longer).

@ilyagr
Copy link
Contributor Author

ilyagr commented Jun 16, 2024

I added a minor fixup (comment deletion) as a separate commit.

@ilyagr ilyagr force-pushed the clap-markdown-new branch from ca9008a to 0650e4b Compare June 16, 2024 00:08
ilyagr added 4 commits June 15, 2024 18:12
I am currently not aware of any severe differences between the generated
markdown and `jj help`, though this could change if we look over the
text carefully or if we start using `clap` features we weren't using
before.
That old commit made a piece of documentation obsolete, but
I didn't realize it at the time.
If I can't tell what this comment means, probably nobody else can
either.

I think it might be a copy-paste error from whatever docs I copied the
initial version of the config from.
@ilyagr ilyagr force-pushed the clap-markdown-new branch from 0650e4b to 20cc26d Compare June 16, 2024 01:12
@ilyagr ilyagr merged commit ce0c537 into jj-vcs:main Jun 16, 2024
17 checks passed
@ilyagr ilyagr deleted the clap-markdown-new branch June 16, 2024 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants