@@ -163,7 +163,7 @@ def run_doc(args: str | list[str]) -> None:
163163@app .command (rich_help_panel = "Docs" )
164164def clean ():
165165 """
166- Delete built website files.
166+ Clean / Delete the documentation build directory
167167 """
168168 if os .path .exists (FULL_BUILD_DIR ):
169169 for item in Path (FULL_BUILD_DIR ).glob ("*" ):
@@ -173,7 +173,7 @@ def clean():
173173@app .command (rich_help_panel = "Docs" )
174174def html ():
175175 """
176- to make standalone HTML files
176+ Build the documentation ( HTML)
177177 """
178178 run_doc ([SPHINX_BUILD , "-b" , "html" , * ALLSPHINXOPTS , f"{ BUILD_DIR } /html" ])
179179 print ()
@@ -183,7 +183,7 @@ def html():
183183@app .command (rich_help_panel = "Docs" )
184184def serve ():
185185 """
186- Build and serve standalone HTML files, with automatic rebuilds and live reload.
186+ Build and serve the docs with automatic rebuilds and live reload.
187187 """
188188 run_doc (
189189 [SPHINX_AUTOBUILD , * SPHINXAUTOBUILDOPTS , "-b" , "html" , * ALLSPHINXOPTS , f"{ BUILD_DIR } /html" ]
@@ -193,7 +193,7 @@ def serve():
193193@app .command (rich_help_panel = "Docs" )
194194def linkcheck ():
195195 """
196- to check all external links for integrity
196+ Check for broken links in the documentation
197197 """
198198 run_doc ([SPHINX_BUILD , "-b" , "linkcheck" , * ALLSPHINXOPTS , f"{ BUILD_DIR } /linkcheck" ])
199199 print ()
@@ -423,27 +423,27 @@ def linkcheck():
423423@app .command (rich_help_panel = "Code Quality" )
424424def lint ():
425425 """
426- Run tasks: ruff, mypy, and pyright (Run this before making a pull request! )
426+ Run tasks: ruff, mypy, and pyright (Run before making a pull request)
427427 """
428428 ruff_check ()
429429 mypy ()
430430 pyright ()
431431
432432
433- @app .command (rich_help_panel = "Code Quality" )
433+ @app .command (rich_help_panel = "Code Quality - Advanced " )
434434def ruff_check ():
435435 """Run ruff check for code quality"""
436436 run ([RUFF , * RUFFOPTS , RUFFOPTS_PACKAGE ])
437437
438438
439439@app .command (rich_help_panel = "Code Quality" )
440440def format (check : bool = False ):
441- """Format code and sort imports with ruff """
441+ """Format code (Run before making a pull request) """
442442 ruff_format (check )
443443 ruff_isort (check )
444444
445445
446- @app .command (rich_help_panel = "Code Quality" )
446+ @app .command (rich_help_panel = "Code Quality - Advanced " )
447447def ruff_format (check : bool = False ):
448448 """Format code using ruff"""
449449 ruff_fmt = [RUFF , "format" ]
@@ -452,38 +452,38 @@ def ruff_format(check: bool = False):
452452 run (ruff_fmt )
453453
454454
455- @app .command (rich_help_panel = "Code Quality" )
455+ @app .command (rich_help_panel = "Code Quality - Advanced " )
456456def ruff_isort (check : bool = False ):
457457 """Sort imports with ruff"""
458458 if not check :
459459 RUFFOPTS_ISORT .append ("--fix" )
460460 run ([RUFF , * RUFFOPTS_ISORT , RUFFOPTS_PACKAGE ])
461461
462462
463- @app .command (rich_help_panel = "Code Quality" )
463+ @app .command (rich_help_panel = "Code Quality - Advanced " )
464464def mypy ():
465465 """Typecheck using mypy"""
466466 run ([MYPY , * MYPYOPTS ])
467467
468468
469- @app .command (rich_help_panel = "Code Quality" )
469+ @app .command (rich_help_panel = "Code Quality - Advanced " )
470470def pyright ():
471471 """Typecheck using pyright"""
472472 run ([PYRIGHT , * PYRIGHTOPTS ])
473473
474474
475- @app .command (rich_help_panel = "Code Quality" )
476- def test_full ():
477- """Run all tests"""
478- run ([PYTEST , TESTDIR ])
479-
480-
481- @app .command (rich_help_panel = "Code Quality" )
475+ @app .command (rich_help_panel = "Tests" )
482476def test ():
483- """Run unit tests (Run this before making a pull request!) """
477+ """Run unit tests"""
484478 run ([PYTEST , UNITTESTS ])
485479
486480
481+ @app .command (rich_help_panel = "Tests" )
482+ def test_full ():
483+ """Run unit and integration tests"""
484+ run ([PYTEST , TESTDIR ])
485+
486+
487487# @app.command(rich_help_panel="Shell Completion")
488488# def whichshell():
489489# """Find out which shell your system seems to be running"""
0 commit comments