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

feat: cli documentation generator conversion from Python to Rust script #1281

Merged
merged 6 commits into from
Sep 5, 2024

Conversation

heeckhau
Copy link
Contributor

@heeckhau heeckhau commented Sep 5, 2024

@DaniPopes @onbjerg as discussed in this Reth PR:

This PR contains a rewrite of the CLI documentation script from Python (help.py) into Rust to improve readability and maintainability. While this isn't a direct 1-to-1 conversion, I kept the implementation as close to the original as possible to simplify the review process. The output remains identical, except for a few non-significant newlines in SUMMARY.md.

This script is an improvement of the script in the PR of the Reth repo. Once it is reviewed here, I can update it on the Reth side too.

Copy link
Member

@DaniPopes DaniPopes left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! I addressed some nits and removed preprocessors for this repo since there are no matches.

@DaniPopes DaniPopes merged commit 8c99ce5 into foundry-rs:master Sep 5, 2024
1 check passed
@heeckhau heeckhau deleted the help_rs branch September 10, 2024 14:33
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