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

Update Trogdor readme commands #16453

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Update Trogdor readme commands #16453

merged 2 commits into from
Jun 26, 2024

Conversation

imcdo
Copy link
Contributor

@imcdo imcdo commented Jun 25, 2024

Remove > characters from the trogdor readme so that people who follow the guide don't accidentally write over their bin files.

More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.

Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Remove `>` characters from the trogdor readme so that people who follow the guide don't accidentally write over their bin files.
115694 Agent

```
jps
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: for the commands that have output, losing the > means that it's not as clear what is the command and what is the output. (The new line might be clear enough)

Seems like an ok enough tradeoff to ensure that folks don't overwrite the files though.

Copy link
Contributor

@jolshan jolshan Jun 25, 2024

Choose a reason for hiding this comment

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

And given this was already the case for copy pasting the whole thing, I'd say this is a net positive, so I think it is ok as proposed in the PR.

@jolshan jolshan merged commit 2074e5a into apache:trunk Jun 26, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants