Skip to content

Commit

Permalink
Improve tool description (#123)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea authored Mar 7, 2023
1 parent 94e3ad0 commit 748af11
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/mk/tools/ansible.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def actions(self) -> List[Action]:
actions.append(
Action(
name=name,
description=f"Run ansible-playbook {filename}",
description=f"[dim]ansible-playbook {filename}[/dim]",
tool=self,
filename=filename,
)
Expand Down
4 changes: 3 additions & 1 deletion src/mk/tools/pre_commit.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ def is_present(self, path: str) -> bool:
return False

def actions(self) -> List[Action]:
return [Action(name="lint", tool=self)]
return [
Action(name="lint", description="[dim]pre-commit run -a[/dim]", tool=self)
]
2 changes: 1 addition & 1 deletion src/mk/tools/shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def actions(self) -> List[Action]:
actions.append(
Action(
name=name,
description="Run {filename}",
description=f"[dim]./{filename}[/dim]",
tool=self,
filename=filename,
)
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ requires =
tox-extra

[testenv]
description = run the tests with pytest under {basepython}
description = Run the tests with pytest
setenv =
COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
COVERAGE_PROCESS_START={toxinidir}/pyproject.toml
Expand Down Expand Up @@ -74,6 +74,7 @@ commands =
mkdocs build {posargs:}

[testenv:lint]
description = Run linters
passenv = {[testenv]passenv}
# without PROGRAMDATA cloning using git for Windows will fail with an
# `error setting certificate verify locations` error
Expand Down

0 comments on commit 748af11

Please sign in to comment.