Skip to content

Fix command for generating API documentation, typo in path - #162

Merged
lalinsky merged 1 commit into
acoustid:masterfrom
zoren:patch-1
Jul 27, 2026
Merged

lalinsky merged 1 commit into
acoustid:masterfrom
zoren:patch-1

Conversation

@zoren

@zoren zoren commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The README’s API documentation instructions now open doc/html/index.html instead of docs/html/index.html. No other changes are included.

Changes

Documentation command update

Layer / File(s) Summary
Update API documentation browser target
README.md
The browser-launch command now targets doc/html/index.html instead of docs/html/index.html.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No description was provided, so the check can't assess anything beyond the PR context. Add a short description of the documentation path fix and any related context.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the only change: correcting the API docs path in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 `@README.md`:
- Line 64: Update the README command from “make doc” to “make docs” so it
matches the existing docs target defined by add_custom_target(docs doxygen).
🪄 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: ASSERTIVE

Plan: Pro

Run ID: d8804c80-4f14-4f2a-b237-be3ca38e8c04

📥 Commits

Reviewing files that changed from the base of the PR and between ab48115 and 4b2dc1a.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 `@README.md`:
- Line 65: Update the README command examples on lines 64–65 by removing the
leading shell prompt markers, including the `$` before `$BROWSER`, while
preserving the commands themselves.
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 2b7c88da-3ed0-483a-9c7b-3ade77a90908

📥 Commits

Reviewing files that changed from the base of the PR and between 4b2dc1a and accc57e.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@lalinsky
lalinsky merged commit 056bd71 into acoustid:master Jul 27, 2026
14 checks passed
@lalinsky

Copy link
Copy Markdown
Member

Thank you

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