Skip to content

[WIP] Vector methods are missing inheritdoc docs #11496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 20, 2025

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original issue description:

Describe the issue or suggestion

Some of the APIs in the System.Runtime.Intrinsics namespace are missing XML doc comments, even though they have <inheritdoc /> tags in the source code (example). We should populate the XML files in this folder with the appropriate inherited doc comments from the source code in the dotnet/runtime repo. Don't just insert <inheritdoc /> tags. Instead, to work around this issue, follow the inherit doc chain to find the actual documentation (for example, for Vector512.Max, follow the inheritdoc chain all the way up till ISimdVector<TSelf, T>.Max and copy the summary, parameter docs, returns, and exception docs from there).

Fixes #11494.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

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.

Vector methods are missing inheritdoc docs
2 participants