Skip to content

Fix api documentation for System.Runtime.Intrinsics#8464

Merged
dakersnar merged 8 commits intodotnet:mainfrom
dakersnar:fix-72402
Oct 10, 2022
Merged

Fix api documentation for System.Runtime.Intrinsics#8464
dakersnar merged 8 commits intodotnet:mainfrom
dakersnar:fix-72402

Conversation

@dakersnar
Copy link
Contributor

@dakersnar dakersnar requested a review from a team as a code owner October 5, 2022 21:33
@ghost ghost assigned dakersnar Oct 5, 2022
@dakersnar dakersnar changed the title Fix api documentation for System/System.Numerics Fix api documentation for System.Runtime.Intrinsics Oct 5, 2022
@ghost
Copy link

ghost commented Oct 5, 2022

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes dotnet/runtime#72402

Author: dakersnar
Assignees: dakersnar
Labels:

area-System.Runtime.Intrinsics

Milestone: -

@dakersnar
Copy link
Contributor Author

dakersnar commented Oct 5, 2022

@gewarren I added a commit with your suggestions (with an extra slash that my IDE was complaining about the lack of). I also changed Vector`1.xml in the same way for consistency.

@gewarren
Copy link
Contributor

gewarren commented Oct 5, 2022

@gewarren I added a commit with your suggestions (with an extra slash that my IDE was complaining about the lack of). I also changed Vector_1.xml in the same way for consistency.

Cool! Which IDE are you using for that functionality?

@opbld31

This comment was marked as outdated.

@dakersnar
Copy link
Contributor Author

dakersnar commented Oct 5, 2022

VSCode. I'm not an XML expert, but I think it is complaining that </typeparam>was closing <typeparamref name="T">. It couldn't quite connect the dots to what the real problem was, but adding the slash in <typeparamref name="T"> fixed it.

edit: and I should note that the first error is just my spellcheck complaining about the word "typeparam", unrelated
image

@opbld32

This comment was marked as outdated.

@gewarren
Copy link
Contributor

gewarren commented Oct 5, 2022

@dakersnar I see you were updating the /// in the source code. I found an extension (XML by Red Hat) to do similar validation in the XML file itself. Thanks for the idea!

image

@opbld34

This comment was marked as outdated.

Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. :shipit:

@opbld30

This comment was marked as outdated.

@dakersnar dakersnar enabled auto-merge October 10, 2022 17:39
@opbld34
Copy link

opbld34 commented Oct 10, 2022

Learn Build status updates of commit a0bf75a:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Numerics/Vector.xml ✅Succeeded View
xml/System.Numerics/Vector`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64`1.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@dakersnar dakersnar merged commit 892bcc5 into dotnet:main Oct 10, 2022
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.

Undocumented 7.0 APIs in System.Runtime.Intrinsics

8 participants