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.

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

docs: populate brief for all live playground examples #35

Merged
merged 2 commits into from
Nov 4, 2024
Merged

docs: populate brief for all live playground examples #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a77ba4
docs: populate brief for all live playground examples
molisani Nov 2, 2024
0620339
Merge branch 'main' into docs/example-briefs
mkubilayk Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/array-argument.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with homogenous positional parameters",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/boolean-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with boolean flag",
customUsage: [
"--quiet",
"--quiet=yes",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/bounded-array-argument.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with bounded positional parameters",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/counter-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with counter flag",
customUsage: [
"--verbose",
"-v",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/default-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with flag configured with default value",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/default-tuple-argument.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with positional parameter configured with default value",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/enum-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ export const root = buildCommand({
},
},
docs: {
brief: ""
brief: "Example for live playground with enum flag"
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/hidden-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ export const root = buildCommand({
},
},
docs: {
brief: ""
brief: "Example for live playground with hidden flag"
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/optional-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with optional flag",
customUsage: [
"",
"--limit 1000",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/optional-tuple-argument.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with optional positional parameter",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/parsed-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with parsed flags",
customUsage: [
"--item apple --price 1",
"--item orange --price 3.5",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/tuple-argument.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with positional parameters",
},
});
2 changes: 1 addition & 1 deletion docs/docs/features/argument-parsing/examples/variadic-flag.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const root = buildCommand({
},
},
docs: {
brief: "",
brief: "Example for live playground with variadic flag",
customUsage: [
"--id 10",
"--id 10 --id 20 --id 30",
Expand Down