-
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
Add binary target to example commands #509
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good!
Note
I wonder if there is a way for us to validate the commands in the docs as part of the CI so this issue does not happen in the future, kind of how rustdoc requires code snippets to compile.
After some research I could not find any ready-made tool that would help us with this. It seems like it would be easy enough though to write a rust binary using pulldown_cmark to parse out the cli commands from our Anyway, extracting the code blocks and just running those commands and checking for an error code + terminating after |
Waiting for someone to merge! Thanks |
Opened a new issue for the automatic checking: #511 |
Pull Request type
What is the current behavior?
Example commands do not work and give an error.
Resolves: #508
What is the new behavior?
Specify the used binary explicitly to make the example commands work again.
Does this introduce a breaking change?
No
Other information