docs: unlink SHADER_ constants in Material.update#8621
Merged
Conversation
The `Material.update` JSDoc linked to `SHADER_FORWARD` and `SHADER_SHADOW`, but these constants are undocumented and stripped from the generated docs (via `excludeNotDocumented`), producing TypeDoc warnings on `Material.update`, `ShaderMaterial.update`, and `StandardMaterial.update` (inherited). Replace the links with a plain list of example pass names (forward, shadow, pick). Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes TypeDoc {@link ...} references from Material.update that pointed to non-public / undocumented SHADER_* constants, eliminating documentation warnings while keeping the intent of the comment clear.
Changes:
- Replaced
{@link SHADER_FORWARD}/{@link SHADER_SHADOW}links with plain example render-pass names (forward,shadow,pick) inMaterial.updateJSDoc.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Material.updatelinked toSHADER_FORWARDandSHADER_SHADOW, but those constants are undocumented and stripped from the generated docs (viaexcludeNotDocumented), producing TypeDoc warnings onMaterial.update,ShaderMaterial.update, andStandardMaterial.update(inherited).Replace the links with a plain list of example pass names (forward, shadow, pick) which is more readable and avoids referencing constants that aren't part of the public API surface.
Test plan
npm run docs- the threeSHADER_SHADOWwarnings are gone.