Skip to content

Commit 06012eb

Browse files
committed
Renamed check_docs and update_docs to match the commands
Signed-off-by: Ole Herman Schumacher Elgesem <ole@northern.tech>
1 parent 6b4856f commit 06012eb

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/cfengine_cli/dev.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
update_dependency_tables as _update_dependency_tables,
99
print_release_dependency_tables,
1010
)
11-
from cfengine_cli.docs import update_docs, check_docs
11+
from cfengine_cli import docs
1212
from cfengine_cli.syntax_tree import syntax_tree
1313

1414

@@ -49,13 +49,13 @@ def print_dependency_tables(args) -> int:
4949

5050
def format_docs(files) -> int:
5151
_expect_repo("documentation")
52-
ret = update_docs(files)
52+
ret = docs.format_docs(files)
5353
return ret
5454

5555

5656
def lint_docs() -> int:
5757
_expect_repo("documentation")
58-
ret = check_docs()
58+
ret = docs.lint_docs()
5959
return ret
6060

6161

src/cfengine_cli/docs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ def _update_docs_single_arg(path):
449449
return formatted
450450

451451

452-
def update_docs(paths) -> int:
452+
def format_docs(paths) -> int:
453453
"""
454454
Iterate through entire docs repo, or specified subfolders / files, autoformatting as much as possible:
455455
- python code with black
@@ -468,7 +468,7 @@ def update_docs(paths) -> int:
468468
return 0
469469

470470

471-
def check_docs() -> int:
471+
def lint_docs() -> int:
472472
"""
473473
Run checks / tests on docs.
474474

0 commit comments

Comments
 (0)