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

Porting new docs for the System namespace #9163

Merged
merged 8 commits into from
Jul 27, 2023

Conversation

tannergooding
Copy link
Member

This handles most of dotnet/runtime#88563. There are some APIs that are missing xml docs entirely that still need to be handled.

@tannergooding tannergooding requested a review from a team as a code owner July 25, 2023 22:24
@ghost ghost assigned tannergooding Jul 25, 2023
@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 Jul 25, 2023
@dotnet-issue-labeler
Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

@tannergooding tannergooding added area-System.Runtime and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Jul 25, 2023
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

I haven't finished, but wanted to send these through meanwhile.

xml/System/ArgumentOutOfRangeException.xml Outdated Show resolved Hide resolved
xml/System/ArgumentOutOfRangeException.xml Outdated Show resolved Hide resolved
xml/System/ArgumentOutOfRangeException.xml Outdated Show resolved Hide resolved
xml/System/ArgumentOutOfRangeException.xml Outdated Show resolved Hide resolved
xml/System/ArgumentOutOfRangeException.xml Outdated Show resolved Hide resolved
xml/System/TimeOnly.xml Outdated Show resolved Hide resolved
xml/System/TimeOnly.xml Outdated Show resolved Hide resolved
xml/System/TimeOnly.xml Outdated Show resolved Hide resolved
xml/System/TimeOnly.xml Outdated Show resolved Hide resolved
xml/System/TimeOnly.xml Outdated Show resolved Hide resolved
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Finished with my review now.

xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
xml/System/TimeProvider.xml Outdated Show resolved Hide resolved
Co-authored-by: Genevieve Warren <[email protected]>
@learn-build-service-prod

This comment was marked as outdated.

Co-authored-by: Genevieve Warren <[email protected]>
@learn-build-service-prod

This comment was marked as outdated.

Co-authored-by: Genevieve Warren <[email protected]>
@learn-build-service-prod

This comment was marked as outdated.

Co-authored-by: Genevieve Warren <[email protected]>
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod
Copy link

Learn Build status updates of commit cea4f6b:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details
xml/System/GC.xml ❌Error Details

  • Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...

xml/System/GC.xml

  • Line 0, Column 0: [Error: ECMA2Yaml_InternalError]
Intenal Several Error: System.ArgumentException: An item with the same key has already been added. Key: totalSize
   at System.Collections.Generic.Dictionary`2.TryInsert(TKey key, TValue value, InsertionBehavior behavior)
   at System.Linq.Enumerable.ToDictionary[TSource,TKey,TElement](IEnumerable`1 source, Func`2 keySelector, Func`2 elementSelector, IEqualityComparer`1 comparer)
   at ECMA2Yaml.ECMALoader.LoadDocs(XElement dElement, String filePath)
   at ECMA2Yaml.ECMALoader.LoadMember(Type t, XElement mElement)
   at System.Linq.Enumerable.SelectEnumerableIterator`2.ToList()
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

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:

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 989a50e:

✅ Validation status: passed

File Status Preview URL Details
xml/System/ArgumentException.xml ✅Succeeded View
xml/System/ArgumentOutOfRangeException.xml ✅Succeeded View
xml/System/Byte.xml ✅Succeeded View
xml/System/Char.xml ✅Succeeded View
xml/System/DateOnly.xml ✅Succeeded View
xml/System/DateTime.xml ✅Succeeded View
xml/System/DateTimeOffset.xml ✅Succeeded View
xml/System/Decimal.xml ✅Succeeded View
xml/System/Delegate.xml ✅Succeeded View
xml/System/Double.xml ✅Succeeded View
xml/System/Enum.xml ✅Succeeded View
xml/System/Environment.xml ✅Succeeded View
xml/System/GC.xml ✅Succeeded View
xml/System/Half.xml ✅Succeeded View
xml/System/Int128.xml ✅Succeeded View
xml/System/Int16.xml ✅Succeeded View
xml/System/Int32.xml ✅Succeeded View
xml/System/Int64.xml ✅Succeeded View
xml/System/IntPtr.xml ✅Succeeded View
xml/System/IUtf8SpanFormattable.xml ✅Succeeded View
xml/System/MemoryExtensions.xml ✅Succeeded View
xml/System/MulticastDelegate.xml ✅Succeeded View
xml/System/OperatingSystem.xml ✅Succeeded View
xml/System/Random.xml ✅Succeeded View
xml/System/SByte.xml ✅Succeeded View

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

@tannergooding
Copy link
Member Author

@gewarren, I believe all the feedback (thanks for being so thorough!) has been accounted for and a new description for the TimeProvider case has been provided.

Please let me know if any other changes are needed.

@gewarren gewarren merged commit bd41ce6 into dotnet:main Jul 27, 2023
2 checks passed
@tannergooding tannergooding deleted the runtime-88563 branch July 27, 2023 18:48
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.

3 participants