Create CLI documentation with a Rust script (instead of Python) + style improvement #10680
Conversation
This file contains 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
onbjerg
approved these changes
Sep 3, 2024
There was a problem hiding this comment.
personally love this, we should give some love to the cargo script feature. curious what others think cc @mattsse @DaniPopes @rkrasiuk @Rjected
DaniPopes
approved these changes
Sep 3, 2024
There was a problem hiding this comment.
Yeah, this is way better, thanks! Also needs to install nightly in CI
This was adapted from the Foundry book (https://github.com/foundry-rs/book/blob/8f8215a10248f8e4d4870e3c03dd836d64169fd1/scripts/gen_output/help.py#L1), would you mind also opening a PR there too?
DaniPopes
reviewed
Sep 3, 2024
shekhirin
added
C-docs
Rjected
reviewed
Sep 5, 2024
+ add Rust nightly to GitHub book lint job
|
This change was merged in Foundry: foundry-rs/book#1281 I've also added Rust nightly to the GitHub workflow file |
DaniPopes
approved these changes
Sep 6, 2024
Rjected
approved these changes
Sep 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I noticed that the CLI documentation was being generated using a Python script, so I rewrote it in Rust to make it easier to understand and more maintainable. Although it’s not a 1-to-1 conversion, I aimed to stay close to the original implementation to facilitate the review process. The output remains identical.
Additionally, I made a small change to the Markdown template (in a separate commit) to enhance the appearance of the generated documentation:
