Skip to content

Update documentation for SerializationSurrogateProvider property #3748

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

Merged
merged 3 commits into from
Jan 28, 2020
Merged

Update documentation for SerializationSurrogateProvider property #3748

merged 3 commits into from
Jan 28, 2020

Conversation

mconnew
Copy link
Member

@mconnew mconnew commented Jan 8, 2020

Summary

Added documentation for DataContractSerializerOperationBehavior.SerializationSurrogateProvider

@dotnet-bot dotnet-bot added this to the December 2019 milestone Jan 8, 2020
@carlossanlop carlossanlop requested review from jozkee, StephenMolloy, a team and HongGit January 8, 2020 21:07
@carlossanlop carlossanlop added 🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Jan 8, 2020
Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

One tiny suggestion to address.

…ationBehavior.xml

Co-Authored-By: Carlos Sanchez Lopez <[email protected]>
Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

LGTM. Left a minor comment for you to consider.

<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a surrogate provider to be used during the serialization and deserialization processes.</summary>
<value>An <see cref="T:System.Runtime.Serialization.ISerializationSurrogateProvider" /> that is used to provide a serialization surrogate used during serialization and deserialization.</value>
Copy link
Contributor

Choose a reason for hiding this comment

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

Given that the type is automatically shown (https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Description.DataContractSerializerOperationBehavior.SerializationSurrogateProvider?branch=pr-en-us-3748&view=dotnet-plat-ext-3.1#property-value), I think you can have the plain text here too

Suggested change
<value>An <see cref="T:System.Runtime.Serialization.ISerializationSurrogateProvider" /> that is used to provide a serialization surrogate used during serialization and deserialization.</value>
<value>A surrogate provider that is used to provide a serialization surrogate to be used during serialization and deserialization.</value>

Copy link
Contributor

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Only Maira's suggestion left to address. I suggest it gets applied. But aside from that, it looks good, and no build warnings/errors.

@mairaw
Copy link
Contributor

mairaw commented Jan 28, 2020

I've applied the suggestion so we can merge this PR.

@mairaw mairaw merged commit 1633960 into dotnet:master Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET Core 2.x Identifies work items for the .NET Core 2.x releases new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants