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

docs: improve README.md inputs usage section #45

Merged
merged 7 commits into from
Jun 20, 2024

Conversation

austinletson
Copy link
Collaborator

@austinletson austinletson commented May 23, 2024

Change the specified values in the README.md usage section to "" instead of the default values.
Add a comment above lint-module, build-args, use-mathilb-cache, and use-github-cache explaining the default behavior.
This format is based on action/checkout.

@austinletson austinletson force-pushed the improve-readme-usage branch 2 times, most recently from e741483 to b886a98 Compare May 30, 2024 11:15
@austinletson
Copy link
Collaborator Author

@semorrison Based on your comment on #44, I am proposing this change to how we document how users can customize lean-action with inputs.

At a high level, do you think this should address your concern?

@austinletson
Copy link
Collaborator Author

I will merge this since I believe it is an overall improvement to the documentation of lean-action's inputs. We can continue to improve the documentation as we approach v1.

@austinletson austinletson merged commit 50b53f3 into main Jun 20, 2024
8 checks passed
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.

None yet

1 participant