Skip to content

Commit

Permalink
Add a Make target that searches for note markers
Browse files Browse the repository at this point in the history
This surfaces the comment convention we inherited from godoc.
We use the parentheses to classify similar notes.

See: https://go.dev/blog/godoc
  • Loading branch information
cbandy committed Dec 20, 2024
1 parent 6468cc5 commit 40a43fa
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ get-pgmonitor:
cp -r '$(PGMONITOR_DIR)/postgres_exporter/common/.' '${QUERIES_CONFIG_DIR}'
cp '$(PGMONITOR_DIR)/postgres_exporter/linux/queries_backrest.yml' '${QUERIES_CONFIG_DIR}'

.PHONY: notes
notes: ## List known issues and future considerations
@command -v rg > /dev/null && rg '(BUGS|FIXME|NOTE|TODO)[(][^)]+[)]' || grep -Ern '(BUGS|FIXME|NOTE|TODO)[(][^)]+[)]' *

.PHONY: clean
clean: ## Clean resources
clean: clean-deprecated
Expand Down

0 comments on commit 40a43fa

Please sign in to comment.