Skip to content

Standardize wording across all documents#260

Closed
extsoft wants to merge 1 commit into
masterfrom
glosarry
Closed

Standardize wording across all documents#260
extsoft wants to merge 1 commit into
masterfrom
glosarry

Conversation

@extsoft

@extsoft extsoft commented Apr 29, 2020

Copy link
Copy Markdown
Owner

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.

The contribution:

  • updates all affected documentation
  • provides commits messages which comply with the CONTRIBUTING.md > Committing the changes rules
  • updates the completion scripts if requires
  • complies with all requirements from README.md > Hands-on development notes

@bees-hive/elegant-git-maintainers, please review.

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.
@extsoft extsoft closed this Apr 30, 2020
@extsoft extsoft deleted the glosarry branch April 30, 2020 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant