urlchecker-action icon indicating copy to clipboard operation
urlchecker-action copied to clipboard

Strawman: Unify writing style of action arguments

Open shyndman opened this issue 3 years ago • 2 comments

This started off as documenting the exclude_patterns parameter (https://github.com/urlstechie/urlchecker-python/issues/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.

shyndman avatar Oct 06 '21 02:10 shyndman

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).

vsoch avatar Oct 06 '21 02:10 vsoch

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

shyndman avatar Oct 06 '21 02:10 shyndman