UsageError typo on --animate-interval #1814
Open
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.
UsageError has a typo, this can cause confusion.
For example under the context of trying to export d2 to .gif for the first time, my flow was:
I checked the Documentation which states correct usage:
d2 in.d2 out.gif
I then followed the error to correct the input, and received a second error:
The correct usage is
d2 in.d2 out.gif --animate-interval <interval as number>
The documentation could also benefit from a refresh in this regard.