Help docs: updates to volumes and apps command help #3558
Conversation
| ` | ||
| short = "Manage apps" | ||
| long = "Manage your Fly applications." | ||
| short = "Manage apps." |
There was a problem hiding this comment.
I don't know what is our stance regarding period at the end of sentences but we recently saw this happening #3552
There was a problem hiding this comment.
ok good to know thanks! the proposed style guide says to have a period for the short desc, but the way of least resistance might be to just go with whatever is already there 😆
There was a problem hiding this comment.
@dangra I looked at this again, and it doesn't make sense to remove the period from short descriptions for top level or sub-commands. Especially when the long desc is "short + more words". The PR you linked to is not a good change for this reason: https://fly.io/docs/flyctl/machine-clone/
Having no period for option descriptions is fine though.
There was a problem hiding this comment.
we'll have to either add periods to all of them, or stop using "short + ..." for long descriptions
Change Summary
What and Why:
How:
Related to:
Documentation