Add 'effect' to JSDoc tag exclusion list #8257
Draft
+21
−1
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.
The custom JSDoc tag
@effectwas incorrectly triggering GitHub user hovers, linking to https://github.com/effect instead of being treated as documentation.Changes
'effect'toJSDOC_NON_USERSarray insrc/common/user.ts(alphabetically between 'desc' and 'enum')src/test/common/user.test.tsto verify the exclusionExample
Previously hovering over
@effectwould show a GitHub user card for the 'effect' user. Now it's correctly ignored as a JSDoc tag, consistent with@param,@returns, and other standard tags.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
jsdoc.app/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.