Skip to content

Fix WebXR documentation errors - #1398

Merged
Arctis-Fireblight merged 1 commit into
Redot-Engine:masterfrom
dominicbytes:docs/webxr-reference
Sep 7, 2026
Merged

Fix WebXR documentation errors#1398
Arctis-Fireblight merged 1 commit into
Redot-Engine:masterfrom
dominicbytes:docs/webxr-reference

Conversation

@dominicbytes

@dominicbytes dominicbytes commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Correct the squeezeend reference and four wording errors in WebXR documentation.

Validation: spelling, RST generation, documentation status and XML schema checks pass.

@dominicbytes
dominicbytes requested review from a team September 7, 2026 05:25
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: f98aab4a-cce5-4cf0-9d84-ef6ec0811e45

📥 Commits

Reviewing files that changed from the base of the PR and between 94cb3ad and 3dcd4eb.

📒 Files selected for processing (1)
  • modules/webxr/doc_classes/WebXRInterface.xml

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


Walkthrough

The WebXRInterface documentation corrects one duplicated signal reference and four wording or spelling errors.

Changes

WebXRInterface documentation

Layer / File(s) Summary
Correct WebXRInterface descriptions
modules/webxr/doc_classes/WebXRInterface.xml
The documentation now references squeezeend correctly and uses the corrected terms “supported” and “comma-separated”.

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

Merge Risk: ⚪ Minimal · up to 3dcd4

This updates WebXRInterface reference text to correctly name squeezeend and fix wording errors. It does not change runtime behavior or public API declarations, and no merge-blocking risk remains.

Suggested reviewers: arctis-fireblight, decryptedchaos

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documented WebXR corrections in the 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.

@dominicbytes dominicbytes changed the title Correct WebXR squeeze signal reference and member descriptions Fix WebXR documentation errors Sep 7, 2026
@Arctis-Fireblight Arctis-Fireblight self-assigned this Sep 7, 2026
@Arctis-Fireblight
Arctis-Fireblight merged commit bac7baa into Redot-Engine:master Sep 7, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants