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

remove $ prefix in shells #1628

Merged
merged 1 commit into from
Dec 8, 2022

Conversation

reubenmiller
Copy link
Contributor

Signed-off-by: Reuben Miller reuben.miller@softwareag.com

Proposed changes

Improves the usefulness of the code blocks by separating the command to the output of the commands. $ command prefixes are also removed. These changes make it easier for the user to copy/paste the command when they are following steps in the documentation.

Related to #1616

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: Reuben Miller <reuben.miller@softwareag.com>
@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Dec 2, 2022
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, despite I prefer the former style with an explicit prompt that helps me to understand that these are shell command samples.

@reubenmiller reubenmiller merged commit 096c286 into thin-edge:main Dec 8, 2022
@reubenmiller reubenmiller deleted the issue-1616-shell-in-docs branch December 8, 2022 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants