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

Add readmes for System.Runtime, System.Runtime.Numerics, System.Buffers, System.Runtime.Intrinsics #77332

Merged
merged 10 commits into from
Nov 30, 2022

Conversation

dakersnar
Copy link
Contributor

Building off of the standard set here: #77134.

This is very much a first draft/WIP, and input is definitely appreciated. I marked areas I need input on with TODOs.

Additionally, here are some other things we might want to borrow from the reflection READMEs:

Additionally, it is unclear to me whether or not I am correctly correlating namespaces, libraries, area labels, and source code locations. For example, the difference between System.Numerics and System.Runtime.Numerics, and the difference between System.Runtime and System. If this stuff is confusing to me, it is probably confusing to other contributors, so we should make sure we clearly explain these connections. Let me know if I've made any mistakes there.

@dakersnar dakersnar added documentation Documentation bug or enhancement, does not impact product or test code area-Meta labels Oct 21, 2022
@ghost ghost assigned dakersnar Oct 21, 2022
@ghost
Copy link

ghost commented Oct 21, 2022

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

Issue Details

Building off of the standard set here: #77134.

This is very much a first draft/WIP, and input is definitely appreciated. I marked areas I need input on with TODOs.

Additionally, here are some other things we might want to borrow from the reflection READMEs:

Additionally, it is unclear to me whether or not I am correctly correlating namespaces, libraries, area labels, and source code locations. For example, the difference between System.Numerics and System.Runtime.Numerics, and the difference between System.Runtime and System. If this stuff is confusing to me, it is probably confusing to other contributors, so we should make sure we clearly explain these connections. Let me know if I've made any mistakes there.

Author: dakersnar
Assignees: -
Labels:

documentation, area-Meta

Milestone: -

Copy link
Contributor

@teo-tsirpanis teo-tsirpanis left a comment

Choose a reason for hiding this comment

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

Left some comments about the NuGet packages.

src/libraries/System.Buffers/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Intrinsics/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Numerics/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime/README.md Outdated Show resolved Hide resolved
@dakersnar dakersnar marked this pull request as ready for review November 10, 2022 17:13
Copy link
Member

@jeffhandley jeffhandley left a comment

Choose a reason for hiding this comment

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

I suggested breaking the tests out into their own headings where appropriate, and avoiding the "tests ... live in ..." wording with differently structured bullets instead.

src/libraries/System.Buffers/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Intrinsics/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Numerics/README.md Outdated Show resolved Hide resolved
Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com>
@dakersnar
Copy link
Contributor Author

@jkotas Thanks for the review, and good catch. I think this is all from a single typo that propagated via copy paste. All instances of "coreclr" should definitely be "libraries". I'll update this now.

@dakersnar
Copy link
Contributor Author

The source of my error was copy-pasting the reference to System.Private.CoreLib from this PR, which references coreclr instead of libraries: https://github.com/dotnet/runtime/pull/76567/files.

src/libraries/System.Buffers/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Intrinsics/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime.Numerics/README.md Outdated Show resolved Hide resolved
src/libraries/System.Runtime/README.md Outdated Show resolved Hide resolved
@dakersnar dakersnar merged commit e7ee837 into dotnet:main Nov 30, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Dec 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta 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.

6 participants