Conversation
📝 WalkthroughWalkthroughDocumentation updates across cursor rules and contributing guides to align test command syntax from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@python/docs/source/contributing/development-environment.md`:
- Around line 49-51: Remove the shell prompt from the fenced code block so
markdownlint MD014 is satisfied: replace the line containing the prompt-prefixed
command "$ make pkg-test-${package_name}" with the bare command "make
pkg-test-${package_name}" inside the existing ```console fenced block in
development-environment.md (identify the command by the text make
pkg-test-${package_name}).
| ```console | ||
| $ make test-pkg-${package_name} | ||
| $ make pkg-test-${package_name} | ||
| ``` |
There was a problem hiding this comment.
Address markdownlint MD014 by removing the shell prompt.
The static analysis warning flags the $ prefix in code blocks. Consider removing the prompt or adding output to satisfy MD014.
Suggested change
-```console
-$ make pkg-test-${package_name}
-```
+```console
+make pkg-test-${package_name}
+```🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 50-50: Dollar signs used before commands without showing output
(MD014, commands-show-output)
🤖 Prompt for AI Agents
In `@python/docs/source/contributing/development-environment.md` around lines 49 -
51, Remove the shell prompt from the fenced code block so markdownlint MD014 is
satisfied: replace the line containing the prompt-prefixed command "$ make
pkg-test-${package_name}" with the bare command "make pkg-test-${package_name}"
inside the existing ```console fenced block in development-environment.md
(identify the command by the text make pkg-test-${package_name}).
There was a problem hiding this comment.
generally yes, however Sphinx documentation builder handle this correctly, so a copy from a codeblock works correctly. this is also the standard thorough the whole repo.
There was a problem hiding this comment.
@evakhoni, thank you for the clarification! I understand that including shell prompts is the established standard in this repository and that Sphinx handles them appropriately for copy/paste functionality. I'll keep this in mind for future reviews.
✏️ Learnings added
Learnt from: evakhoni
Repo: jumpstarter-dev/jumpstarter PR: 198
File: python/docs/source/contributing/development-environment.md:49-51
Timestamp: 2026-02-04T17:50:41.624Z
Learning: In the jumpstarter repository, shell prompts (`$`) in console code blocks are intentionally kept in documentation despite markdownlint MD014 warnings. Sphinx documentation builder handles these correctly, and this is the standard throughout the repository.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
🧠 Learnings used
Learnt from: CR
Repo: jumpstarter-dev/jumpstarter PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-02-04T16:25:31.463Z
Learning: Use `make pkg-test-<package_name>` for running package-specific tests
Learnt from: CR
Repo: jumpstarter-dev/jumpstarter PR: 0
File: .cursor/rules/project-structure.mdc:0-0
Timestamp: 2026-02-04T16:25:57.924Z
Learning: Use `make test-pkg-<package_name>` for running package tests, never invoke pytest manually
Learnt from: CR
Repo: jumpstarter-dev/jumpstarter PR: 0
File: .cursor/rules/project-structure.mdc:0-0
Timestamp: 2026-02-04T16:25:57.924Z
Learning: Use `make pkg-ty-<package_name>` for type checking instead of running pytest manually
Learnt from: CR
Repo: jumpstarter-dev/jumpstarter PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-02-04T16:25:31.463Z
Learning: Use `make pkg-ty-<package_name>` for running type checking on packages
Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter PR: 271
File: docs/source/conf.py:53-53
Timestamp: 2025-02-10T20:39:47.893Z
Learning: In Sphinx configuration, setting `doctest_test_doctest_blocks = ""` specifically disables automatic testing of standard reStructuredText doctest blocks (those using >>> syntax without explicit directives), while still allowing testing of blocks explicitly marked with .. doctest::, .. testcode::, or other doctest directives.
2 participants
according to makefile, we're using
make pkg-test-for testing a package, however few places mentionmake test-pkg-instead, which seems like a typo.Summary by CodeRabbit
make pkg-test-${package_name}instead ofmake test-pkg-${package_name}for running package-specific tests.