Skip to content

Automatic port of System.Formats.Cbor documentation #4919

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Oct 1, 2020
Merged

Automatic port of System.Formats.Cbor documentation #4919

merged 9 commits into from
Oct 1, 2020

Conversation

carlossanlop
Copy link
Contributor

Thanks @eiriktsarpalis for letting me know that these APIs had not yet been ported.

CC @gewarren @safern

@carlossanlop carlossanlop added the new-content Indicates PRs that contain new articles label Sep 30, 2020
@opbld33

This comment has been minimized.

Sign in to view
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Sep 30, 2020
View reviewed changes
@opbld30

This comment has been minimized.

Sign in to view
jozkee
jozkee reviewed Sep 30, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop and others added 2 commits September 30, 2020 17:54
@carlossanlop
Apply suggestions from code review
355c5ad
@carlossanlop @jozkee
Apply suggestions from code review
61b63f2 
Co-authored-by: David Cantú <dacantu@microsoft.com>
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
carlossanlop
carlossanlop commented Oct 1, 2020
View reviewed changes
@opbld31

This comment has been minimized.

Sign in to view
jozkee
jozkee approved these changes Oct 1, 2020
View reviewed changes
Copy link
Member

@jozkee jozkee left a comment

Choose a reason for hiding this comment

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

Mostly suggestions to adjust to the boilerplate formats; otherwise, LGTM.

@opbld31

This comment has been minimized.

Sign in to view
@carlossanlop @jozkee
Apply suggestions from code review
1fa2f56 
Co-authored-by: David Cantú <dacantu@microsoft.com>
@opbld33

This comment has been minimized.

Sign in to view
@opbld32

This comment has been minimized.

Sign in to view
eiriktsarpalis
eiriktsarpalis reviewed Oct 1, 2020
View reviewed changes
eiriktsarpalis
eiriktsarpalis reviewed Oct 1, 2020
View reviewed changes
@carlossanlop @eiriktsarpalis
Apply suggestions from code review
8941503 
Co-authored-by: Eirik Tsarpalis <eirik.tsarpalis@gmail.com>
@opbld31
Copy link

opbld31 commented Oct 1, 2020

Docs Build status updates of commit 8941503:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml ⚠️Warning View Details
xml/System.Formats.Cbor/CborConformanceMode.xml ✅Succeeded View
xml/System.Formats.Cbor/CborReader.xml ✅Succeeded View
xml/System.Formats.Cbor/CborReaderState.xml ✅Succeeded View
xml/System.Formats.Cbor/CborSimpleValue.xml ✅Succeeded View
xml/System.Formats.Cbor/CborTag.xml ✅Succeeded View
xml/System.Formats.Cbor/CborWriter.xml ✅Succeeded View

xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.PolicyRegistry'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

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.

Note: Your PR may contain errors or warnings 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
Contributor Author

The build warnings are unrelated. cc @joelmartinez @TianqiZhang
This is ready to merge.

@carlossanlop carlossanlop merged commit e5bd866 into dotnet:release-net5-rc2 Oct 1, 2020
@carlossanlop carlossanlop deleted the Cbor branch October 1, 2020 17:32
gewarren
gewarren reviewed Jan 21, 2021
View reviewed changes
xml/System.Formats.Cbor/CborReaderState.xml
@@ -34,7 +34,8 @@
</ReturnValue>
<MemberValue>19</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the next CBOR data item encodes a <see cref="T:System.Boolean" /> value (major type 7).</summary>
<remarks>To be added.</remarks>
Copy link
Contributor

Choose a reason for hiding this comment

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

@carlossanlop Remarks on enum fields are invalid and (now) cause build warnings. Can you update DocsPortingTool to not add this for enum fields?

Copy link
Contributor

Choose a reason for hiding this comment

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

I created dotnet/api-docs-sync#24.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eiriktsarpalis eiriktsarpalis eiriktsarpalis approved these changes

@gewarren gewarren gewarren left review comments

@jozkee jozkee jozkee approved these changes

@BillWagner BillWagner Awaiting requested review from BillWagner

Assignees

@carlossanlop carlossanlop

@eiriktsarpalis eiriktsarpalis

Labels
area-System.Formats.Cbor new-content Indicates PRs that contain new articles
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@carlossanlop @opbld33 @opbld30 @opbld31 @opbld32 @eiriktsarpalis @jozkee @gewarren