Skip to content

make pkg-test typo #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mangelajo merged 1 commit into from
Feb 4, 2026
Merged

make pkg-test typo #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .cursor/rules/creating-new-drivers.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The script automatically creates:
- Follow existing code style (validate with `make lint`, fix with `make lint-fix`)
- Perform static type checking with `make ty-pkg-${package_name}`
- Add comprehensive tests and update documentation
- Verify all tests pass (`make test-pkg-${package_name}` or `make test`)
- Verify all tests pass (`make pkg-test-${package_name}` or `make test`)

## Contributing Guidelines

Expand Down
2 changes: 1 addition & 1 deletion .cursor/rules/project-structure.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ python/examples/

### Testing

- **Package tests**: `make test-pkg-<package_name>`
- **Package tests**: `make pkg-test-<package_name>`
- **All tests**: `make test`
- **Coverage**: Configured per package with HTML and XML reports

Expand Down
2 changes: 1 addition & 1 deletion python/docs/source/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you have questions, reach out in our Matrix chat or open an issue on GitHub.
- Follow code style (validate with `make lint`, fix with `make lint-fix`)
- Perform static type checking with (`make ty-pkg-${package_name}`)
- Add tests and update documentation. New drivers/features need tests and docs.
- Verify all tests pass (`make test-pkg-${package_name}` or `make test`)
- Verify all tests pass (`make pkg-test-${package_name}` or `make test`)

### Commit Messages

Expand Down
2 changes: 1 addition & 1 deletion python/docs/source/contributing/development-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ $ make test
You can also run specific tests with:

```console
$ make test-pkg-${package_name}
$ make pkg-test-${package_name}
```
Comment on lines 49 to 51
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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}).

Copy link
Contributor Author

@evakhoni evakhoni Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.


## Go Environment
Expand Down
Loading