Skip to content

Commit 3195451

Browse files
committed
doc: better help texts for profiles and config commands
1 parent deddc0a commit 3195451

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

Diff for: src/robotcode/cli/commands/config.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
)
2222
def config() -> None:
2323
"""\
24-
View configuration information.
24+
View configuration informations.
2525
"""
2626

2727

@@ -37,7 +37,7 @@ def show(
3737
paths: List[Path],
3838
) -> None:
3939
"""\
40-
Shows the Robot Framework configuration.
40+
Shows the current _robot_ configuration.
4141
4242
Takes a list of PATHS or if no PATHS are given, takes the current working directory,
4343
to search for configuration files and prints the current configuration.
@@ -77,7 +77,7 @@ def files(
7777
paths: List[Path],
7878
) -> None:
7979
"""\
80-
Shows Robot Framework configuration files.
80+
Search for _robot_ configuration files and list them.
8181
8282
Takes a list of PATHS or if no PATHS are given, takes the current working directory,
8383
to search for configuration files and prints them.
@@ -128,7 +128,7 @@ def root(
128128
paths: List[Path],
129129
) -> None:
130130
"""\
131-
Shows the root of the Robot Framework project.
131+
Searches for the root folder of the _robot_ project and prints them.
132132
133133
Takes a list of PATHS or if no PATHS are given, takes the current working directory,
134134
to search for the root of the project and prints this.

Diff for: src/robotcode/cli/commands/profiles.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
invoke_without_command=False,
1515
)
1616
def profiles() -> None:
17-
"""View profile informations."""
17+
"""View _robot_ profile informations."""
1818

1919

2020
@profiles.command
@@ -28,7 +28,7 @@ def show(
2828
no_evaluate: bool,
2929
paths: List[Path],
3030
) -> None:
31-
"""Shows the given Robot Framework profile."""
31+
"""Shows the given _robot_ profile."""
3232
try:
3333
config_files, _, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
3434

@@ -52,7 +52,7 @@ def list(
5252
app: Application,
5353
paths: List[Path],
5454
) -> None:
55-
"""List the defined profiles in the given Robot Framework configuration."""
55+
"""Lists the defined profiles in the current _robot_ configuration."""
5656

5757
try:
5858
config_files, _, discovered_by = get_config_files(

0 commit comments

Comments
 (0)