Command: criticalup doc
#78
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
Hoverbear
reviewed
Jan 23, 2025
Hoverbear
reviewed
Jan 23, 2025
crates/criticalup-cli/src/errors.rs
Outdated
| @@ -120,6 +120,19 @@ pub(crate) enum Error { | |||
| tracing_subscriber::util::TryInitError, | |||
| ), | |||
|
|
|||
| #[error("Failed to open document in the browser at {}", path.display())] | |||
There was a problem hiding this comment.
Can we provide the user with a proper file url for their browser so they can link-click it or paste it directly?
I think you can use https://docs.rs/url/latest/url/struct.Url.html#method.from_file_path
There was a problem hiding this comment.
I like this idea. Let me change this.
Hoverbear
reviewed
Jan 23, 2025
|
Rest looks good. :) |
amanjeev
force-pushed
the
amanjeev/sub-command-doc
branch
from
45cee7a to
474ec74
Compare
Tests should not open users' browsers. Reviewed-by: Ana Hobden <ana.hobden@ferrous-systems.com>
Reviewed-by: Ana Hobden <ana.hobden@ferrous-systems.com>
amanjeev
force-pushed
the
amanjeev/sub-command-doc
branch
from
739c1c3 to
439f036
Compare
Hoverbear
previously approved these changes
Jan 27, 2025
Hoverbear
force-pushed
the
amanjeev/sub-command-doc
branch
from
27bde10 to
f34f237
Compare
|
bors merge |
|
👎 Rejected by too few approved reviews |
|
Build succeeded: |
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.
Adds a sub-command
docso the user does not have to look for docs manually.For a given installation:
criticalup docopens the doc url in default browser on the system.criticalup doc --pathprints the path to the doc root.