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

fix: consolidate command descriptions, order #70

Merged
merged 2 commits into from
Jan 13, 2023

Conversation

line-o
Copy link
Member

@line-o line-o commented Jan 12, 2023

  • always start with a capital character
  • remove redundant information (~instance)
  • fix wording (connection -> collection)
  • re-order and group commands
  • display commands in table with aliases
  • use main command in examples instead of aliases

Preview of readme after changes https://github.com/eXist-db/xst/blob/f5ab970b720562c053f3cd68503cc441cb66962b/readme.md

Thanks to valuable feedback from @JoernT and Pieter

- always start with a capital character
- remove redundant information (~instance)
- fix wording (connection -> collection)
- re-order and group commands
- display available commands in a table with aliases
- Consolidate examples, use main command instead of alias.
@line-o line-o requested a review from a team January 12, 2023 22:30
@line-o line-o merged commit 598b37c into eXist-db:main Jan 13, 2023
@line-o line-o deleted the fix/command-desc branch January 13, 2023 09:16
@github-actions
Copy link

🎉 This PR is included in version 1.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants