Skip to content

Commit

Permalink
Standardize wording across all documents
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
extsoft committed Apr 30, 2020
1 parent de7a94b commit 6c44e24
Show file tree
Hide file tree
Showing 28 changed files with 390 additions and 257 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: >-
Thank you for submitting the first issue!
Thank you for submitting the first issue!
You're making a great contribution to improve Elegant Git.
pr-message: >-
Thank you for making the first contribution!
Expand Down
4 changes: 3 additions & 1 deletion .workflows/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ def header(command: str):
def normalize_command_line(line: str):
if line.startswith("usage:"):
return f"```bash\n{line}\n```\n"
if line.startswith("http"):
return f"<{line}>\n"
return f"{line}\n"


Expand All @@ -27,7 +29,7 @@ def body() -> Sequence[str]:
data = []
print("Explain 'git-elegant'...")
data.append(header("git-elegant"))
data.append("```bash\n")
data.append("```\n")
data.extend(map(lambda line: f"{line}\n", command_output("bin/git-elegant")))
data.append("```\n\n")
for command in command_output(["bin/git-elegant", "show-commands"]):
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ If you need to write a message to the system output, please use public functions
for printing them.

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

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

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

The [docs/commands.md](docs/commands.md) generates by running `./workflows generate-docs` script.
Expand Down
30 changes: 15 additions & 15 deletions completions/_git-elegant
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ _git-elegant (){
typeset -A opt_args
_arguments -C ':command:->command' '*::option:->option'
local all_commands=(
'accept-work:applies a branch on top of \`master\` branch'
'acquire-git:configures a Git installation'
'acquire-repository:configures current repository'
'amend-work:amends some changes to the most recent commit'
'clone-repository:clones a repository and configures it'
'deliver-work:publishes current branch to a remote repository'
'accept-work:adds modifications to the default development branch'
'acquire-git:configures your Git installation'
'acquire-repository:configures the current local Git repository'
'amend-work:amends the last commit'
'clone-repository:clones a remote repository and configures it'
'deliver-work:publishes HEAD to a remote repository'
'init-repository:initializes a new repository and configures it'
'make-workflow:makes a new workflow file for the repository'
'obtain-work:checkouts a remote branch matching by a name'
'polish-work:reapplies branch commits interactively'
'polish-workflow:edits a given workflows file'
'make-workflow:makes a new workflow file'
'obtain-work:checkouts a remote-tracking branch'
'polish-work:rebases HEAD interactively'
'polish-workflow:opens a given workflow file'
'prune-repository:removes useless local branches'
'release-work:releases available work as a new annotated tag'
'release-work:releases the default development branch'
'save-work:commits current modifications'
'show-commands:prints available Elegant Git commands'
'show-release-notes:prints a release log between two references'
'show-work:shows a state of current work in progress'
'show-workflows:shows configured workflows in the repository'
'show-commands:prints Elegant Git commands'
'show-release-notes:prints a release log between two refs'
'show-work:prints HEAD state'
'show-workflows:prints file locations of the configured workflows'
'start-work:creates a new branch'
)

Expand Down
Loading

0 comments on commit 6c44e24

Please sign in to comment.