LCORE-584: add missing Makefile targets into documentation #478
Conversation
WalkthroughMakefile target descriptions were standardized and exposed in help output. An internal target _black was renamed to black. The README’s Make targets list was updated to reflect these names and descriptions. Functional commands remain unchanged; updates are limited to target naming and descriptive text. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
README.md (2)
563-563: Hyphenate “end‑to‑end”.Prefer “end-to-end” per common style; also keep this consistent with the Makefile.
-test-e2e Run end to end tests for the service +test-e2e Run end-to-end tests for the service
575-579: Tool naming/wording nits: “analyzer” (US) and “pydocstyle”.Use “analyzer” for consistency and refer to the tool by name “pydocstyle”.
-pylint Check source code using Pylint static code analyser + pylint Check source code using Pylint static code analyzer @@ -docstyle Check the docstring style using Docstyle checker +docstyle Check docstring conventions with pydocstyleMakefile (4)
23-24: Hyphenate “end‑to‑end”.Minor wording tweak for consistency with docs.
-test-e2e: ## Run end to end tests for the service +test-e2e: ## Run end-to-end tests for the service
48-50: Run the doc generator under the project’s virtual env.Invoking the script via uv+python is more robust (shebang/executable bit not required) and consistent with other targets.
-doc: ## Generate documentation for developers - scripts/gen_doc.py +doc: ## Generate documentation for developers + uv run python scripts/gen_doc.py
73-83: Wording nits: “analyzer” and “pydocstyle”.Align terminology with tool names.
-pylint: ## Check source code using Pylint static code analyser +pylint: ## Check source code using Pylint static code analyzer @@ -docstyle: ## Check the docstring style using Docstyle checker +docstyle: ## Check docstring conventions with pydocstyle
88-95: Shorten verify body (checkmake maxbodylength).Collapse repeated invocations into one; matches the static-analysis hint.
-verify: ## Run all linters - $(MAKE) black - $(MAKE) pylint - $(MAKE) pyright - $(MAKE) ruff - $(MAKE) docstyle - $(MAKE) check-types +verify: ## Run all linters + $(MAKE) $(LINT_TARGETS)Add this near the top with other vars:
LINT_TARGETS := black pylint pyright ruff docstyle check-types
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
Makefile(3 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 checkmake (0.2.2)
Makefile
[warning] 88-88: Target body for "verify" exceeds allowed length of 5 (6).
(maxbodylength)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build-pr
- GitHub Check: e2e_tests
1 participant
Description
LCORE-584: add missing Makefile targets into documentation
Type of change
Related Tickets & Documents
Summary by CodeRabbit
New Features
Documentation
Chores