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

Strawman: Unify writing style of action arguments #81

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

shyndman
Copy link

@shyndman shyndman commented Oct 6, 2021

This started off as documenting the exclude_patterns parameter (urlstechie/urlchecker-python#60), but I decided to take a stab at writing the param descriptions with a more consistent style.

I'm not attached to anything. Please feel free to criticize or suggest alternatives.

If accepted, I'll update the rest of this project (actions.yml, the examples, etc.), and https://github.com/urlstechie/urlchecker-python, to reflect the decisions.

@vsoch
Copy link
Collaborator

vsoch commented Oct 6, 2021

These changes look great to me - much more succinct and clear. If you'd like to add more to this PR, I'd be happy to review again (and ping me when ready) or we can split into separate PRs.

And I'm wondering if it makes sense to switch the default branch from master to main (another PR of course) since it will be main as default on GitHub from here on out (and many of my default branches I've changed to main).

@shyndman
Copy link
Author

shyndman commented Oct 6, 2021

Excellent. Will do.

And I'm wondering if it makes sense to switch the default branch from master to main (another PR of course) since it will be main as default on GitHub from here on out (and many of my default branches I've changed to main).

sgtm

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

Successfully merging this pull request may close these issues.

2 participants