Skip to content
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

docs: change phrasing of cd related text #113

Merged
merged 1 commit into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ ghr shell fish --completion | source
Usage: ghr <COMMAND>

Commands:
cd Changes directory into a repository (Shell extension required)
cd Change directory to one of the managed repositories (Shell extension required)
clone Clones a Git repository to local
delete Deletes a repository from local
init Initialises a Git repository in local
Expand All @@ -94,7 +94,7 @@ ghr clone ssh://[email protected]/<owner>/<repo>.git
ghr clone [email protected]:<owner>/<repo>.git
```

If you have installed the shell extension, you can change directory into the cloned repository:
If you have installed the shell extension, you can change directory to the cloned repository:

```shell
ghr clone <url_or_pattern> --cd
Expand All @@ -112,7 +112,7 @@ ghr clone <repo>
```

### Changing directory
You can change directory into a repository on the shell.
You can change directory to one of the managed repositories on the shell.
It requires installing the shell extension.

```shell
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/cd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use clap::Parser;

#[derive(Debug, Parser)]
pub struct Cmd {
/// URL or pattern of the repository to change directory into.
/// URL or pattern of the repository where to change directory to.
repo: String,
}

Expand Down
4 changes: 2 additions & 2 deletions src/cmd/clone.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ pub struct Cmd {
#[clap(short, long)]
recursive: bool,

/// Change directory after cloned a repository (Shell extension required).
/// Change directory after cloning the repository (Shell extension required).
#[clap(long)]
cd: bool,

/// Opens the directory after cloned a repository.
/// Opens the directory after cloning the repository.
#[clap(long)]
open: Option<Option<String>>,
}
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use clap::{Parser, Subcommand};

#[derive(Debug, Subcommand)]
pub enum Action {
/// Changes directory into a repository (Shell extension required).
/// Change directory to one of the managed repositories (Shell extension required).
Cd(cd::Cmd),
/// Clones a Git repository to local.
Clone(clone::Cmd),
Expand Down