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.

Sign up for GitHub

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

Jump to bottom

Improved usage messages for actions #402

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improved usage messages for actions #402

wants to merge 2 commits into from

Conversation

chrysle
Copy link
Contributor

@chrysle chrysle commented Jan 20, 2023 •
edited

Before submitting a pull request, please make sure the following is done:

  • Fork the repository and create your branch from master.
  • If you've added code that should be tested, add tests!
  • Ensure the test suite passes.
  • Format your code with ShellCheck.
  • Include a human-readable description of what the pull request is trying to accomplish.
  • Steps for the reviewer(s) on how they can manually QA the changes.
  • Have a fixes #XX reference to the issue that this pull request fixes.

I have substituted all occurrences of ITEM# with NR and converted the usage messages to the suggested syntax. Remind me if I forgot something. I have also added another $errmsg variable for the addto action to avoid duplicating the usage message.

Fixes #401

@chrysle
Copy link
Contributor Author

chrysle commented Jan 20, 2023

By the way, I wonder if support for 18.04 could be dropped by now, since it's EOL in April?

@inkarkat
Copy link
Member

Yes, we should update to more recent Ubuntu versions, and the MacOS platforms have been completely broken for way too long. @karbassi will hopefully soon dedicate some time for that.

@chrysle chrysle requested a review from inkarkat March 5, 2023 13:22
@chrysle
Copy link
Contributor Author

chrysle commented Mar 5, 2023

Sorry. Completely forgot the usage in USAGE.md!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@inkarkat inkarkat inkarkat approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

How is todo.sh [do] supposed to work?
2 participants
@chrysle @inkarkat