Print something when nickel doc succeeds #1729
Merged
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
vkleen
approved these changes
Nov 30, 2023
cli/src/doc.rs
Outdated
| out_path | ||
| .as_ref() | ||
| .map(Cow::as_ref) | ||
| .unwrap_or(DEFAULT_OUT_DIR) |
There was a problem hiding this comment.
Suggested change
| .unwrap_or(DEFAULT_OUT_DIR) | |
| .expect("There should always be an output path") |
Since we're always producing an output path if self.stdout is not set, I feel it would be better to panic here if no output path gets set. Just as an insurance policy against the path logic changing in the future.
There was a problem hiding this comment.
Good point, but then I think I prefer to destructure the option instead of relying on the related-but-the-compiler-can't-prove-it boolean flag. That is, if out_path is Some, we print it, otherwise we don't print anything.
The doc subcommand has been reported to be a bit confusing, because it generates file in a default location but just returns without further details upon success. This commits add a print statement that says where the document has been generated instead.
yannham
force-pushed
the
fix/nickel-doc-show-out-loc
branch
from
b557d09
to
8fb8f72
Compare
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.
Closues #1656.
The doc subcommand has been reported as confusing, because it generates file in a default location but just returns silently upon success. This PR adds a print statement that says where the document has been generated instead, and serves a confirmation that everything went well as well.