Skip to content
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

Explicitly use para separators in the System.Runtime.Intrinsics XML docs #106652

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

tannergooding
Copy link
Member

@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Aug 19, 2024
@tannergooding tannergooding added documentation Documentation bug or enhancement, does not impact product or test code area-System.Runtime.Intrinsics and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Aug 19, 2024
@tannergooding
Copy link
Member Author

This is a fairly mechanical change and was done via a general search/replace

Copy link
Contributor

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

@@ -8,150 +8,150 @@ namespace System.Runtime.Intrinsics.Arm
public enum SveMaskPattern : byte
{
/// <summary>
/// POW2
/// <para>POW2</para>
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it's needed for single lines, but might be OK anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

In this case it was more about getting the bulk of it correct without needing to manually audit all the lines.

I'll see if I can recognize the single line case and fix it up to not include the tag...

Copy link
Member Author

Choose a reason for hiding this comment

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

Was able to construct a regex that handled the scenario here, should no longer have <para> for single line summaries

@tannergooding tannergooding merged commit 1140d4d into dotnet:main Aug 21, 2024
147 checks passed
@tannergooding tannergooding deleted the para-sri-xml branch August 21, 2024 14:57
@github-actions github-actions bot locked and limited conversation to collaborators Sep 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Runtime.Intrinsics documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants