Skip to content

Conversation

russelmrcl
Copy link
Collaborator

@russelmrcl russelmrcl commented Sep 29, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Suppressed handling of "see" tags in documentation annotations to eliminate unnecessary warnings.
    • Results in cleaner build/log outputs with no change to runtime behavior or features.

@russelmrcl russelmrcl requested a review from rrayst September 29, 2025 13:30
Copy link
Contributor

coderabbitai bot commented Sep 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Expanded the NEGATIVE tag list in Doc.java to include "see", altering which tags are ignored during handling without changing control flow.

Changes

Cohort / File(s) Summary
Doc tag filtering
annot/src/main/java/com/predic8/membrane/annot/model/doc/Doc.java
Updated static final NEGATIVE list to include "see" (["author","param","see"]), causing "see" tags to be ignored during processing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my nose at tags I see,
Now “see” is something not for me—
I hop past notes of who and why,
Let “author,” “param,” “see” all fly.
In fields of docs I lightly tread,
Ignoring lines the code once read. 🐇✨

✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch edit-javadoc

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c57d60 and 2d7aa3c.

📒 Files selected for processing (1)
  • annot/src/main/java/com/predic8/membrane/annot/model/doc/Doc.java (1 hunks)

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.

@rrayst rrayst merged commit 9dda259 into master Sep 29, 2025
2 of 4 checks passed
@rrayst rrayst deleted the edit-javadoc branch September 29, 2025 13:31
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