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

Update reflection metadata doc #8476

Merged
merged 2 commits into from
Oct 12, 2022
Merged

Conversation

steveharter
Copy link
Member

Summary

Addresses feedback from dotnet/runtime#76567 (comment). cc @jkotas, @jeffhandley

The reflection metadata doc is lacking and this PR helps, at least for the most common classes.

@opbld34
Copy link

opbld34 commented Oct 7, 2022

Learn Build status updates of commit 86ba8bc:

✅ Validation status: passed

File Status Preview URL Details
xml/ns-System.Reflection.Metadata.Ecma335.xml ✅Succeeded View
xml/ns-System.Reflection.Metadata.xml ✅Succeeded View
xml/ns-System.Reflection.PortableExecutable.xml ✅Succeeded View
xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.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:

Copy link
Member

@jkotas jkotas left a comment

Choose a reason for hiding this comment

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

Thanks

xml/ns-System.Reflection.Metadata.xml Outdated Show resolved Hide resolved
@MSDN-WhiteKnight
Copy link
Contributor

Consider expanding what low-level means here. For example, SRM is different from other libraries in that it could throw unmanaged access violation exceptions when using APIs on MetadataReader referring to disposed PeReader, instead of ObjectDisposedException. Not sure it's worth mentioning in namespace remarks, but it is very annoying in desktop apps, because on AV the whole process just dies with very poor error diagnostics.

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@steveharter steveharter enabled auto-merge October 12, 2022 17:49
@opbld34
Copy link

opbld34 commented Oct 12, 2022

Learn Build status updates of commit 7620aa9:

✅ Validation status: passed

File Status Preview URL Details
xml/ns-System.Reflection.Metadata.Ecma335.xml ✅Succeeded View
xml/ns-System.Reflection.Metadata.xml ✅Succeeded View
xml/ns-System.Reflection.PortableExecutable.xml ✅Succeeded View
xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.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:

@steveharter steveharter merged commit e55b015 into dotnet:main Oct 12, 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.

5 participants