Skip to content

Commit 6c44e24

Browse files
committed
Standardize wording across all documents
First of all, all used terminology is aligned with Git glossary (`git help gitglossary`). It's also relevant for the names of some variables in the scripts. Next change is the update of the documentation of the command for both command-line help and WEB documentation. The update tries to express the meaning and logic of the commands in an unambiguous manner. All trailing whitespaces are removed from all project files. Last but not least, don't add `bash` syntax for describing `git-elegant` help during the `commands.md` generation as it is just a message.
1 parent de7a94b commit 6c44e24

28 files changed

+390
-257
lines changed

.github/workflows/greetings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
with:
1111
repo-token: ${{ secrets.GITHUB_TOKEN }}
1212
issue-message: >-
13-
Thank you for submitting the first issue!
13+
Thank you for submitting the first issue!
1414
You're making a great contribution to improve Elegant Git.
1515
pr-message: >-
1616
Thank you for making the first contribution!

.workflows/docs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ def header(command: str):
1919
def normalize_command_line(line: str):
2020
if line.startswith("usage:"):
2121
return f"```bash\n{line}\n```\n"
22+
if line.startswith("http"):
23+
return f"<{line}>\n"
2224
return f"{line}\n"
2325

2426

@@ -27,7 +29,7 @@ def body() -> Sequence[str]:
2729
data = []
2830
print("Explain 'git-elegant'...")
2931
data.append(header("git-elegant"))
30-
data.append("```bash\n")
32+
data.append("```\n")
3133
data.extend(map(lambda line: f"{line}\n", command_output("bin/git-elegant")))
3234
data.append("```\n\n")
3335
for command in command_output(["bin/git-elegant", "show-commands"]):

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ If you need to write a message to the system output, please use public functions
9797
for printing them.
9898

9999
### Debug mode
100-
You can enable debug mode by running `export GED=1` (the equivalent of `set -x` for `bash`).
101-
Run `unset GED` to switch debug off.
100+
You can enable debug mode by running `export GED=1` (the equivalent of `set -x` for `bash`).
101+
Run `unset GED` to switch debug off.
102102

103103
### Testing procedure
104104
A testing procedure consists of 3 steps:
@@ -148,7 +148,7 @@ The behavior should be descriptive-style (`stops with exit code 45 if cloneable
148148
rather than imperative-style (`stop with exit code 45 if cloneable URL is not set`).
149149

150150
### Updating documentation
151-
In order to get the documentation preview locally, please install required dependencies with
151+
In order to get the documentation preview locally, please install required dependencies with
152152
`pip install -r docs/requirements.txt`. After, run `./workflows serve-docs`. That's it!
153153

154154
The [docs/commands.md](docs/commands.md) generates by running `./workflows generate-docs` script.

completions/_git-elegant

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ _git-elegant (){
1111
typeset -A opt_args
1212
_arguments -C ':command:->command' '*::option:->option'
1313
local all_commands=(
14-
'accept-work:applies a branch on top of \`master\` branch'
15-
'acquire-git:configures a Git installation'
16-
'acquire-repository:configures current repository'
17-
'amend-work:amends some changes to the most recent commit'
18-
'clone-repository:clones a repository and configures it'
19-
'deliver-work:publishes current branch to a remote repository'
14+
'accept-work:adds modifications to the default development branch'
15+
'acquire-git:configures your Git installation'
16+
'acquire-repository:configures the current local Git repository'
17+
'amend-work:amends the last commit'
18+
'clone-repository:clones a remote repository and configures it'
19+
'deliver-work:publishes HEAD to a remote repository'
2020
'init-repository:initializes a new repository and configures it'
21-
'make-workflow:makes a new workflow file for the repository'
22-
'obtain-work:checkouts a remote branch matching by a name'
23-
'polish-work:reapplies branch commits interactively'
24-
'polish-workflow:edits a given workflows file'
21+
'make-workflow:makes a new workflow file'
22+
'obtain-work:checkouts a remote-tracking branch'
23+
'polish-work:rebases HEAD interactively'
24+
'polish-workflow:opens a given workflow file'
2525
'prune-repository:removes useless local branches'
26-
'release-work:releases available work as a new annotated tag'
26+
'release-work:releases the default development branch'
2727
'save-work:commits current modifications'
28-
'show-commands:prints available Elegant Git commands'
29-
'show-release-notes:prints a release log between two references'
30-
'show-work:shows a state of current work in progress'
31-
'show-workflows:shows configured workflows in the repository'
28+
'show-commands:prints Elegant Git commands'
29+
'show-release-notes:prints a release log between two refs'
30+
'show-work:prints HEAD state'
31+
'show-workflows:prints file locations of the configured workflows'
3232
'start-work:creates a new branch'
3333
)
3434

0 commit comments

Comments
 (0)