Update cli.rs #11148
Open
Update cli.rs #11148
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
nagisa
requested changes
May 6, 2024
| #[clap(long)] | ||
| target_home: PathBuf, | ||
| /// file containing an optional secret as generated by the |
There was a problem hiding this comment.
Why were these descriptions removed?
| #[clap(long)] | ||
| config_path: Option<PathBuf>, | ||
| } | ||
|
|
||
| impl RunCmd { | ||
| fn run(self) -> anyhow::Result<()> { | ||
| //returning a Result instead of unwrapping, to handle any error properly |
There was a problem hiding this comment.
Please follow the rustdoc documentation guidelines. Some things that stand out immediately:
=====is very seldom used -- this is my first time seeing it used for Rust documentation;///denotes a doc-comment and should be used here;- I don't think code comments need to motivate a specific return value as you did here, nor they should be used to keep a changelog to the functions – we have git for that after all.
| @@ -67,16 +61,17 @@ impl RunCmd { | |||
| } | |||
| None | |||
| }; | |||
|
|
|||
There was a problem hiding this comment.
Trailing whitespace is unnecessary. Have you run cargo fmt after making your changes?
| ) | ||
| .global(); | ||
|
|
||
| /* |
There was a problem hiding this comment.
We generally strive to not have commented-out code… You probably should remove this.
| // This makes it safe to move out of the captured variable `runtime`, which is done by a trick | ||
| // using a `swap` of `Cell<Option<Runtime>>`s. | ||
| let runtime_cell = Cell::new(Some(runtime)); | ||
| //using tokio::runtime::Runtime directly |
There was a problem hiding this comment.
Same comment here as above.
| runtime_cell.swap(&r); | ||
| r.into_inner().unwrap() | ||
| }) | ||
| } | ||
|
|
||
| //MirrorCommand::run is now asynchronous, and it awaits the result of the RunCmd::run method when applicable. |
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.
Summary
RunCmd::runnow returns aResultinstead of unwrapping, ensuring that any errors are properly handled.RunCmd::runmethod is now marked as asynchronous and properly awaits the asynchronous operations within it.MirrorCommand::runis now asynchronous, and it awaits the result of theRunCmd::runmethod when applicable.tokio::runtime::Runtimedirectly. for consistent error handling.