File tree Expand file tree Collapse file tree 1 file changed +15
-2
lines changed
Expand file tree Collapse file tree 1 file changed +15
-2
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,8 @@ A current suggestion for how Slack CLI inputs are handled and outputs are format
55- ** Input**
66 - [ Prompts are Flags with Forms] ( #prompts-are-flags-with-forms )
77- ** Output**
8- - [ Format Sections with Command Details] ( #format-sections-with-command-details )
8+ - [ Help Descriptions find Complete Sentences] ( #help-descriptions-find-complete-sentences )
9+ - [ Section Formats with Command Headings] ( #section-formats-with-command-headings )
910
1011## Input
1112
@@ -23,7 +24,19 @@ A flag option should exist for each prompt with a form fallback. Either default
2324
2425Results of a command go toward informing current happenings and suggesting next steps.
2526
26- ### Format Sections with Command Details
27+ ### Help Descriptions find Complete Sentences
28+
29+ The output of extended help descriptions should be complete sentences:
30+
31+ ``` txt
32+ $ slack docs search --help
33+ Search the Slack developer docs and return results in text, JSON, or browser
34+ format.
35+ ```
36+
37+ This example uses punctuation and breaks lines at or before the 80 character count.
38+
39+ ### Section Formats with Command Headings
2740
2841A command often prints information and details about the process happenings. We format this as a section:
2942
You can’t perform that action at this time.
0 commit comments