Skip to content

docs: exclude package-private members from API reference#492

Merged
wprzytula merged 1 commit into
scylladb:mainfrom
dgarcia360:docs-exclude-package
Jun 23, 2026
Merged

docs: exclude package-private members from API reference#492
wprzytula merged 1 commit into
scylladb:mainfrom
dgarcia360:docs-exclude-package

Conversation

@dgarcia360

Copy link
Copy Markdown
Contributor

Closes #484

How to test

  1. Build the docs.
  2. Open http://127.0.0.1:5500/api/Client/
  3. Check there are no (package) members.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The js-doc-config.js file is updated to add an explicit access configuration array containing "public", "protected", and "undefined". Explanatory comments are also added to describe the intent. This prevents members tagged with @package from appearing in the generated public API documentation, as JSDoc will now only render members matching the listed access levels.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: exclude package-private members from API reference' directly and clearly describes the main change in the PR.
Description check ✅ Passed The description references issue #484 and provides testing instructions related to excluding package-private members from API documentation.
Linked Issues check ✅ Passed The PR successfully addresses issue #484 by modifying js-doc-config.js to exclude @package members from the public API documentation.
Out of Scope Changes check ✅ Passed The changes are limited to js-doc-config.js with configuration updates focused on excluding package-private members, which is directly aligned with the linked issue objective.
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.


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.

@dgarcia360

Copy link
Copy Markdown
Contributor Author

cc/ @adespawn @annastuchlik

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@js-doc-config.js`:
- Around line 7-10: The access property in the JSDoc configuration is currently
set to an array value, but JSDoc v4 expects a single string value. Change the
access property from the array format ["public", "protected", "undefined"] to a
single string value representing the desired access level, such as "public" or
"protected". Note that JSDoc v4 only supports filtering by a single access level
at a time, so you will need to choose one primary access level for the access
property.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a9bab65a-b18b-4d54-9033-97541cb461f9

📥 Commits

Reviewing files that changed from the base of the PR and between 1df6525 and d951d0d.

📒 Files selected for processing (1)
  • js-doc-config.js

Comment thread js-doc-config.js
@wprzytula wprzytula added the documentation Improvements or additions to documentation label Jun 23, 2026
@wprzytula wprzytula added this to the 0.7 milestone Jun 23, 2026
@wprzytula wprzytula merged commit 4d3f645 into scylladb:main Jun 23, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API documentation contains package-private members

2 participants