@@ -47,14 +47,16 @@ def show(
47
47
"""\
48
48
Shows the Robot Framework configuration.
49
49
50
- Takes a list of PATHS or if no paths are given, takes the current working directory,
50
+ Takes a list of PATHS or if no PATHS are given, takes the current working directory,
51
51
to search for configuration files and prints the current configuration.
52
52
53
53
\b
54
54
Examples:
55
- robotcode config show
56
- robotcode config show tests/acceptance/first.robot
57
- robotcode config show --format json
55
+ ```
56
+ robotcode config show
57
+ robotcode config show tests/acceptance/first.robot
58
+ robotcode config show --format json
59
+ ```
58
60
"""
59
61
60
62
config_files , _ , _ = get_config_files (paths , app .config .config_files , verbose_callback = app .verbose )
@@ -88,13 +90,16 @@ def files(
88
90
"""\
89
91
Shows Robot Framework configuration files.
90
92
91
- Takes a list of PATHS or if no paths are given, takes the current working directory,
93
+ Takes a list of PATHS or if no PATHS are given, takes the current working directory,
92
94
to search for configuration files and prints them.
93
95
94
96
\b
95
97
Examples:
96
- robotcode config files
97
- robotcode config files tests/acceptance/first.robot
98
+
99
+ ```
100
+ robotcode config files
101
+ robotcode config files tests/acceptance/first.robot
102
+ ```
98
103
"""
99
104
100
105
try :
@@ -119,13 +124,16 @@ def root(
119
124
"""\
120
125
Shows the root of the Robot Framework project.
121
126
122
- Takes a list of PATHS or if no paths are given, takes the current working directory,
127
+ Takes a list of PATHS or if no PATHS are given, takes the current working directory,
123
128
to search for the root of the project and prints this.
124
129
125
130
\b
126
131
Examples:
127
- robotcode config root
128
- robotcode config root tests/acceptance/first.robot
132
+
133
+ ```
134
+ robotcode config root
135
+ robotcode config root tests/acceptance/first.robot
136
+ ```
129
137
"""
130
138
131
139
root_folder , discovered_by = find_project_root (* (paths or []))
@@ -189,9 +197,12 @@ def list(app: Application, name: Optional[List[str]] = None) -> Union[str, int,
189
197
190
198
\b
191
199
Examples:
192
- robotcode config info list
193
- robotcode config info list rebot.*
194
- robotcode config info list *tag*
200
+
201
+ ```
202
+ robotcode config info list
203
+ robotcode config info list rebot.*
204
+ robotcode config info list *tag*
205
+ ```
195
206
"""
196
207
if not name :
197
208
name = ["*" ]
@@ -213,16 +224,18 @@ def desc(app: Application, name: Optional[List[str]] = None) -> Union[str, int,
213
224
"""\
214
225
Shows the description of the specified configuration settings.
215
226
216
- If no NAME is gibven shows the description of all possible configuration settings.
227
+ If no NAME is given shows the description of all possible configuration settings.
217
228
Wildcards are supported.
218
229
219
230
\b
220
231
Examples:
221
- robotcode config info desc
222
- robotcode config info desc python-path
223
- robotcode config info desc rebot.*
224
- robotcode config info desc *tag*
225
232
233
+ ```
234
+ robotcode config info desc
235
+ robotcode config info desc python-path
236
+ robotcode config info desc rebot.*
237
+ robotcode config info desc *tag*
238
+ ```
226
239
"""
227
240
if not name :
228
241
name = ["*" ]
0 commit comments