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

Port System.Buffers new docs (second pass) #10212

Merged
merged 4 commits into from
Aug 7, 2024

Conversation

carlossanlop
Copy link
Member

Ports some docs that were missed in the first pass.

Contributes to dotnet/runtime#105978

Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-buffers

This comment was marked as outdated.

Copy link

Learn Build status updates of commit 2bbe11c:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/System.Runtime.InteropServices/NFloat.xml ⚠️Warning View Details
xml/System.Buffers.Binary/BinaryPrimitives.xml ✅Succeeded View
xml/System.Buffers.Text/Base64Url.xml ✅Succeeded View
xml/System.Buffers/NIndex.xml ✅Succeeded View
xml/System.Buffers/NRange.xml ✅Succeeded View
xml/System.Buffers/SearchValues.xml ✅Succeeded View

xml/System.Runtime.InteropServices/NFloat.xml

  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@carlossanlop
Copy link
Member Author

The NFloat failure is unrelated to this PR, I'm fixing it here: #10211 (comment)

@@ -24,8 +24,14 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represent a type can be used to index a collection either from the start or the end.</summary>
Copy link
Member

Choose a reason for hiding this comment

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

Does this version of the docs have the new Experimental attribute that was applied to it for .NET 9?

Copy link
Member

Choose a reason for hiding this comment

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

Same question applies to NRange

Copy link
Member Author

Choose a reason for hiding this comment

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

@tannergooding When was the attribute added? I am asking because currently, dotnet-api-docs is pointing to Preview6.

@carlossanlop carlossanlop enabled auto-merge (squash) August 7, 2024 20:12
@carlossanlop carlossanlop merged commit f8b0e7e into dotnet:main Aug 7, 2024
3 checks passed
@carlossanlop carlossanlop deleted the PortSystemBuffers branch August 7, 2024 20:12
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.

2 participants