Skip to content

Fix some doc details#2317

Open
Vampire wants to merge 1 commit intomasterfrom
vampire/fix-docs
Open

Fix some doc details#2317
Vampire wants to merge 1 commit intomasterfrom
vampire/fix-docs

Conversation

@Vampire
Copy link
Member

@Vampire Vampire commented Mar 13, 2026

Summary by CodeRabbit

  • Documentation
    • Updated minimum version requirements for Byte Buddy (1.9.7+) and Mockito core (4.11+).
    • Clarified mock maker configuration options and noted support for features like Serializable mocking.
    • Added release notes about optional class-loading support in OSGi and similar environments (ContextClassLoader usage).

Copy link
Member Author

Vampire commented Mar 13, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 95c92eab-48c9-41a9-ab3b-d77f7fdd51ef

📥 Commits

Reviewing files that changed from the base of the PR and between b0e7385 and 76551f1.

📒 Files selected for processing (2)
  • docs/extensions.adoc
  • docs/release_notes.adoc
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/extensions.adoc
  • docs/release_notes.adoc

📝 Walkthrough

Walkthrough

Updated documentation: bumped Byte Buddy requirement to 1.9.7+, expanded Mockito Mock Maker notes (configurable features and dependency requirement), reorganized release notes bullets, and documented optional-class loading via ReflectionUtil using the ContextClassLoader (e.g., OSGi).

Changes

Cohort / File(s) Summary
Extension docs
docs/extensions.adoc
Updated Byte Buddy requirement to 1.9.7+; expanded Mockito Mock Maker section with note on configuring additional Mockito features (e.g., Serializable) and added requirement for org.mockito:mockito-core 4.11+.
Release notes
docs/release_notes.adoc
Reordered a bullet about well-known Jvm versions, removed strike-through formatting from collection matchers entry and adjusted wording, and added note that optional classes may be loaded via ReflectionUtil using the ContextClassLoader (helps OSGi-like environments).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇 Docs hopped forward, version bright,
Byte Buddy set to newer light,
Mockito options now in view,
OSGi loads classes too,
A rabbit's nibble—docs renewed!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fix some doc details' is vague and generic, using non-descriptive language that doesn't clearly convey what documentation issues were addressed in the changeset. Consider using a more specific title that describes the actual documentation fixes, such as 'Update Byte Buddy and Mockito requirements in extension docs' or 'Fix release notes formatting and dependencies'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch vampire/fix-docs
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link

greptile-apps bot commented Mar 13, 2026

Greptile Summary

This PR makes three small, targeted corrections to the Spock documentation — no source code is changed.

  • docs/extensions.adoc: Tightens the documented minimum version requirement for Byte Buddy from the vague 1.9+ to the more precise 1.9.7+.
  • docs/release_notes.adoc (2.4-M5): Fixes a misplaced sub-bullet — the ** Built-in extensions have been updated to use this new interface where applicable line is moved back under its correct parent (Add IStatelessAnnotationDrivenExtension…) instead of appearing as a child of the unrelated Add new well-known versions to Jvm helper… entry.
  • docs/release_notes.adoc (2.4-M3): Removes the [.line-through] AsciiDoc strikethrough that was incorrectly applied to the Improve collection matchers… entry, since that feature was not retracted (the subsequent regression was fixed in M4).

Confidence Score: 5/5

  • This PR is safe to merge — it is a documentation-only change with no impact on compiled code.
  • All three changes are straightforward documentation corrections (version number precision, sub-bullet hierarchy fix, and strikethrough removal). There is no risk of runtime or build breakage.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/extensions.adoc Updates the minimum required Byte Buddy version from 1.9+ to 1.9.7+, making the documented version requirement more precise.
docs/release_notes.adoc Two fixes: (1) moves the ** sub-bullet for IStatelessAnnotationDrivenExtension back under its correct parent bullet, and (2) removes the incorrect strikethrough formatting from the "Improve collection matchers" entry in 2.4-M3.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR: Fix some doc details] --> B[docs/extensions.adoc]
    A --> C[docs/release_notes.adoc]

    B --> D["Byte Buddy version requirement\n1.9+ → 1.9.7+"]

    C --> E["2.4-M5 section\nMove sub-bullet under correct parent\n(IStatelessAnnotationDrivenExtension)"]
    C --> F["2.4-M3 section\nRemove strikethrough from\n'Improve collection matchers' entry"]
Loading

Last reviewed commit: b0e7385

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/extensions.adoc (1)

1123-1123: ⚠️ Potential issue | 🟡 Minor

Tighten wording for the Mockito feature bullet.

Line 1123 reads awkwardly (“additional Mockito feature like mock Serializable”). Consider plural + verb form for clarity.

✏️ Suggested doc wording
-** Can be configured to use additional Mockito feature like mock `Serializable`
+** Can be configured to use additional Mockito features, like mocking `Serializable`
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/extensions.adoc` at line 1123, Update the bullet phrasing to use plural
and a verb form for clarity: replace "** Can be configured to use additional
Mockito feature like mock `Serializable`" with something like "** Can be
configured to use additional Mockito features, such as mocking `Serializable`"
so it reads grammatically correct and clearer; edit the line containing that
exact sentence in docs/extensions.adoc (the Mockito feature bullet) to the
suggested wording or a similar pluralized/verb-form alternative.
🤖 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/release_notes.adoc`:
- Line 205: The release notes bullet contains a duplicated preposition ("in
nested in") — update the string in the release notes entry that currently reads
"Improve collection matchers by supporting them in nested in complex assertions"
to a correct phrasing such as "Improve collection matchers by supporting them in
nested complex assertions" (or "supporting them in nested complex
assertions"/"in complex nested assertions") so the duplicate "in" is removed;
edit the text found in the release notes entry for the collection matchers to
replace the incorrect phrase.

---

Outside diff comments:
In `@docs/extensions.adoc`:
- Line 1123: Update the bullet phrasing to use plural and a verb form for
clarity: replace "** Can be configured to use additional Mockito feature like
mock `Serializable`" with something like "** Can be configured to use additional
Mockito features, such as mocking `Serializable`" so it reads grammatically
correct and clearer; edit the line containing that exact sentence in
docs/extensions.adoc (the Mockito feature bullet) to the suggested wording or a
similar pluralized/verb-form alternative.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8f93f204-dd92-4cc2-98dc-7ce6cfad5b31

📥 Commits

Reviewing files that changed from the base of the PR and between 9c6342c and b0e7385.

📒 Files selected for processing (2)
  • docs/extensions.adoc
  • docs/release_notes.adoc

@codecov
Copy link

codecov bot commented Mar 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.16%. Comparing base (9c6342c) to head (76551f1).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #2317      +/-   ##
============================================
- Coverage     82.16%   82.16%   -0.01%     
+ Complexity     4822     4821       -1     
============================================
  Files           472      472              
  Lines         15036    15036              
  Branches       1905     1905              
============================================
- Hits          12355    12354       -1     
  Misses         1989     1989              
- Partials        692      693       +1     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants