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

Improve Help Consistency #485

Merged
merged 7 commits into from
Feb 17, 2019

Conversation

Lakelezz
Copy link
Contributor

The help-system accumulated a few inconsistencies and this pull request aims to remove some.

Changes:

  • Usage-text in the plain help does no longer lack ticks around the command.
  • Usage-text prepends the first group-prefix if available.
  • The wording "strike'd" (or striked in code) got replaced with the proper typographical presentation named "Strikethrough".
  • Some formatting was indented on the wrong line for no particular reason.
  • Usage-text had two methods to set it and one got removed.
  • "Sample usage" got simplified to "Usage".
  • Some public structs got altered.

Due to changes to the length of help and potentially causing the created help-message to exceed the maximum length and the nature of changing public interfaces, this is a breaking pull request.

@Lakelezz Lakelezz added enhancement An improvement to Serenity. docs Related to documentation. labels Feb 17, 2019
@Lakelezz Lakelezz added this to the 0.6 milestone Feb 17, 2019
@Lakelezz Lakelezz merged commit c74fbb2 into serenity-rs:v0.6.x Feb 17, 2019
@Lakelezz Lakelezz mentioned this pull request Feb 25, 2019
18 tasks
arqunis pushed a commit to arqunis/serenity that referenced this pull request Apr 6, 2019
arqunis pushed a commit to arqunis/serenity that referenced this pull request Apr 6, 2019
@Lakelezz Lakelezz deleted the improve-help-consistency branch April 19, 2020 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation. enhancement An improvement to Serenity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants