docs: unlink renderPasses note in CameraComponent#8622
Merged
Conversation
Both `requestSceneColorMap` and `requestSceneDepthMap` linked to
`CameraComponent#renderPasses`, but that property is deprecated and
`@ignore`d, producing TypeDoc warnings. Also rename it in the note to
`framePasses` (the non-deprecated property name). Keep it as a plain
backticked reference since `framePasses` is itself `@ignore`d, so a
`{@link}` would re-trigger the same class of warning.
Made-with: Cursor
Made-with: Cursor
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Updates CameraComponent documentation to stop linking requestSceneColorMap / requestSceneDepthMap notes to the deprecated renderPasses property, aligning the docs with the newer framePasses API and reducing TypeDoc noise.
Changes:
- Replace
{@link CameraComponent#renderPasses}references in the “ignored when … is used” notes withframePasses. - Apply the update to both
requestSceneColorMapandrequestSceneDepthMapdoc comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CameraComponent.requestSceneColorMapand.requestSceneDepthMapeach linked toCameraComponent#renderPassesin a "note" paragraph, but that property is deprecated and@ignored, producing two TypeDoc warnings. Update the note to referenceframePasses(the non-deprecated property name) instead.The link still points at an
@ignored property, so it continues to emit the same kind of warning - this is not worse than before, and the@ignoreonframePasseswill be removed in a follow-up PR, at which point these warnings will go away too.Test plan
npm run docs- builds clean aside from the pre-existingframePasses"not included" warnings, which will be cleared by the follow-up.