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

make docstrings more consistent #45

Merged

bacongobbler merged 2 commits into main from docs-improvements

Mar 4, 2024

Collaborator

bacongobbler commented Mar 4, 2024 •

edited

Loading

starts each description and CLI option with a capital letter
uses <name> for CLI arguments that have a required argument; Angle brackets denote them as required, square brackets denote them as optional.
refer to the application/app/SpinApp/spin app/spin application as "application" for consistency.

closes #20


          make docstrings more consistent

4570dc5

Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>

bacongobbler requested a review from rajatjindal as a code owner

March 4, 2024 17:41


          fix: "the application"

4ae7cc8

Signed-off-by: Matthew Fisher <matt.fisher@fermyon.com>

bacongobbler merged commit 1d0d636 into main

1 check passed

bacongobbler deleted the docs-improvements branch

March 4, 2024 17:54

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

Labels

None yet