@@ -145,7 +145,7 @@ ifndef MIGRATE_MSG
145145 $(error MIGRATE_MSG is undefined)
146146endif
147147
148- db-migrate-create : check-migrate-msg
148+ db-migrate-create : check-migrate-msg # # Create database migration with description MIGRATE_MSG
149149 $(alembic_cmd ) revision --autogenerate -m " $( MIGRATE_MSG) "
150150
151151MIGRATE_MERGE_MSG := Merge multiple heads
@@ -171,10 +171,10 @@ test: ## Run all tests except for audit logging tests
171171test-audit : # # Run audit logging tests
172172 $(PY_RUN_CMD ) pytest -m " audit" $(args )
173173
174- test-watch :
174+ test-watch : # # Run tests continually and watch for changes
175175 $(PY_RUN_CMD ) pytest-watch --clear $(args )
176176
177- test-coverage :
177+ test-coverage : # # Run tests and generate coverage report
178178 $(PY_RUN_CMD ) coverage run --branch --source=src -m pytest -m " not audit" $(args )
179179 $(PY_RUN_CMD ) coverage report
180180
@@ -186,15 +186,15 @@ test-coverage-report: ## Open HTML test coverage report
186186# Formatting and linting
187187# #################################################
188188
189- format :
189+ format : # # Format files
190190 $(PY_RUN_CMD ) isort --atomic src tests
191191 $(PY_RUN_CMD ) black src tests
192192
193- format-check :
193+ format-check : # # Check file formatting
194194 $(PY_RUN_CMD ) isort --atomic --check-only src tests
195195 $(PY_RUN_CMD ) black --check src tests
196196
197- lint : lint-py
197+ lint : lint-py # # Lint
198198
199199lint-py : lint-flake lint-mypy
200200
@@ -235,3 +235,6 @@ login: start ## Start shell in running container
235235# Pauses for 5 seconds
236236sleep-5 :
237237 sleep 5
238+
239+ help : # # Prints the help documentation and info about each command
240+ @grep -E ' ^[/a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST ) | sort | awk ' BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
0 commit comments