Update some docs still referencing Sputnik and JUnit runner and clarify situation of Jupiter extensions#2322
Update some docs still referencing Sputnik and JUnit runner and clarify situation of Jupiter extensions#2322
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates: clarified Spock’s JUnit Platform engine wording, expanded guidance and a NOTE about third‑party extensions and JUnit Jupiter compatibility, adjusted primer terminology and Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 |
Greptile SummaryDocumentation-only PR that modernizes references from the legacy Sputnik/JUnit runner terminology to the current JUnit Platform engine terminology, and adds guidance on JUnit Jupiter extension compatibility with Spock.
Confidence Score: 4/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["introduction.adoc"] -->|"Updated: JUnit runner → JUnit Platform engine"| B["Terminology Modernization"]
C["spock_primer.adoc"] -->|"Updated: Sputnik → @Testable / JUnit Platform"| B
C -->|"Updated: JUnit comparison table with Jupiter annotations"| D["JUnit 4 + Jupiter Annotations"]
C -->|"Added: JUnit Jupiter extensions NOTE"| E["Jupiter Extension Compatibility Warning"]
F["extensions.adoc"] -->|"Added: JUnit Jupiter extensions NOTE"| E
F -->|"Added: community-driven disclaimer"| G["Third-Party Extensions Clarity"]
H["parallel_execution.adoc"] -->|"Fixed: extra whitespace"| I["Minor Cleanup"]
Last reviewed commit: 41e1127 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![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
🧹 Nitpick comments (1)
docs/spock_primer.adoc (1)
860-875: Consider linking to shared extension guidance instead of duplicating the full NOTE.This block substantially duplicates the third-party/Jupiter guidance already present in
docs/extensions.adoc(Line 794-809), which may drift over time.Refactor direction
-[NOTE] --- -...long Jupiter/3rd-party compatibility note... --- +[NOTE] +-- +For details on JUnit Jupiter extension compatibility and third-party Spock extension recommendations, see +<<extensions.adoc#extensions,Extensions>> and especially the +<<extensions.adoc#third-party-extensions,Third-Party Extensions>> section. +--🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/spock_primer.adoc` around lines 860 - 875, The NOTE about JUnit Jupiter/third‑party integration is a duplicate of the guidance in the shared extensions doc; remove this duplicated NOTE block in docs/spock_primer.adoc and replace it with a cross‑reference to the canonical guidance (the existing "Extensions" / third‑party Jupiter guidance section) so the content is maintained in one place; ensure the referenced section/anchor exists and update the link text to clearly point readers to the shared guidance instead of copying the full paragraph.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/spock_primer.adoc`:
- Line 851: Typo in docs: update the sentence describing the `@IgnoreRest`
annotation in docs/spock_primer.adoc so "featurews" is corrected to "features"
(the line that reads "`@IgnoreRest`:: Any feature method carrying this
annotation will be executed, all others will be ignored. Useful for quickly
running just a few featurews."). Leave the rest of the sentence and punctuation
unchanged and only replace the misspelled word.
---
Nitpick comments:
In `@docs/spock_primer.adoc`:
- Around line 860-875: The NOTE about JUnit Jupiter/third‑party integration is a
duplicate of the guidance in the shared extensions doc; remove this duplicated
NOTE block in docs/spock_primer.adoc and replace it with a cross‑reference to
the canonical guidance (the existing "Extensions" / third‑party Jupiter guidance
section) so the content is maintained in one place; ensure the referenced
section/anchor exists and update the link text to clearly point readers to the
shared guidance instead of copying the full paragraph.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 22f534db-55dc-43fb-b303-ebf2b8d5e550
📒 Files selected for processing (4)
docs/extensions.adocdocs/introduction.adocdocs/parallel_execution.adocdocs/spock_primer.adoc
Vampire
force-pushed
the
vampire/doc-updates
branch
from
41e1127 to
ca3745f
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/spock_primer.adoc (1)
851-851:⚠️ Potential issue | 🟡 MinorFix the typo "featurews" → "features".
While updating this line's description, the existing typo "featurews" should also be corrected to "features". A past review already flagged this typo.
🔤 Proposed fix
-`@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful for quickly running just a few featurews. +`@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful for quickly running just a few features.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/spock_primer.adoc` at line 851, Typo in the `@IgnoreRest` docstring: replace "featurews" with "features" and update the sentence to read "`@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful for quickly running just a few features." Locate the line describing `@IgnoreRest` and correct the misspelling and ensure the sentence grammar matches the proposed text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/spock_primer.adoc`:
- Line 851: Typo in the `@IgnoreRest` docstring: replace "featurews" with
"features" and update the sentence to read "`@IgnoreRest`:: Any feature method
carrying this annotation will be executed, all others will be ignored. Useful
for quickly running just a few features." Locate the line describing
`@IgnoreRest` and correct the misspelling and ensure the sentence grammar
matches the proposed text.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 98538821-5cfe-4847-a274-bdb3e543397d
📒 Files selected for processing (4)
docs/extensions.adocdocs/introduction.adocdocs/parallel_execution.adocdocs/spock_primer.adoc
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/extensions.adoc
- docs/parallel_execution.adoc
- docs/introduction.adoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2322 +/- ##
=========================================
Coverage 82.16% 82.16%
Complexity 4822 4822
=========================================
Files 472 472
Lines 15036 15036
Branches 1905 1905
=========================================
+ Hits 12354 12355 +1
Misses 1989 1989
+ Partials 693 692 -1 🚀 New features to boost your workflow:
|
| Go to the <<extensions.adoc#extensions,Extensions>> chapter to learn how to implement your own directives and extensions, | ||
| to learn where to find some of the 3rd party extensions, and to learn about all built-in extensions and directives. | ||
|
|
||
| [NOTE] |
There was a problem hiding this comment.
Why do we include this twice?
There was a problem hiding this comment.
I feared you'd ask that. :-D
I think it is important information to reduce the amount of issues reported in the style of "this JUnit extension does not work with Spock".
Topic-wise I'd say it more belongs to the 3rd-party extensions section, as it is about 3rd-party "extensions", even though they are no Spock extensions but that is what users can wrongly assume easily and also in the Wiki article they might find a replacement or the bridging-extension.
But I think if a user reads the docs at all, then it is more likely that they read the Spock Primer, at least to start with, so wanted to increase visibility of this admonition by having it there too.
The Extensions chapter in the Spock primer is anyway just an information duplication chapter, as it lists an excerpt of the built-in extensions with short description (and even states or at least implies that those are the only ones built-in). So I thought it might be a good idea to have the note there a second time.
Vampire
force-pushed
the
vampire/doc-updates
branch
from
569574c to
9c9273f
Compare
…fy situation of Jupiter extensions
Vampire
force-pushed
the
vampire/doc-updates
branch
from
9c9273f to
0287abe
Compare
3 participants
Summary by CodeRabbit