Added comment about virtual methods #3105
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a line about not overriding virtual methods because of issues involved with it.
|
This seems like a small (but important) contribution, so no Contribution License Agreement is required at this point. We will now review your pull request. |
mairaw
reviewed
Sep 11, 2017
xml/System.Net.Http/HttpClient.xml
Outdated
| @@ -25,7 +25,7 @@ | |||
| ## Remarks | |||
| The <xref:System.Net.Http.HttpClient> class instance acts as a session to send HTTP requests. An <xref:System.Net.Http.HttpClient> instance is a collection of settings applied to all requests executed by that instance. In addition, every <xref:System.Net.Http.HttpClient> instance uses its own connection pool, isolating its requests from requests executed by other <xref:System.Net.Http.HttpClient> instances. | |||
|
|
|||
| The <xref:System.Net.Http.HttpClient> also acts as a base class for more specific HTTP clients. An example would be a FacebookHttpClient providing additional methods specific to a Facebook web service (a GetFriends method, for instance). | |||
| The <xref:System.Net.Http.HttpClient> also acts as a base class for more specific HTTP clients. An example would be a FacebookHttpClient providing additional methods specific to a Facebook web service (a GetFriends method, for instance). Derived classes should not override the virtual methods on the class. Use the constructor overload accepting <xref:System.Net.Http.HttpMessageHandler> to configure any pre- or post-request processing instead. | |||
There was a problem hiding this comment.
LGTM. Wondering if it would be better to say "Use a constructor overload that accepts" since there's more than one though.
/cc @stevewhims
There was a problem hiding this comment.
The "instead" works well to flow the thought from one sentence to the next, but I'd put the "instead" at the start of the 2nd sentence. Then the reader doesn't need to wait till the end of the sentence to parse that connection. So: "Instead, use a constructor overload that accepts ...".
JRAlexander
added
the
✨ 1st-time docs contributor!
|
Thanks @CoolDadTx for adding this. I've made some minor changes based on the feedback given, so we can merge this PR. I'll wait for the CI build to finish before merging. The fix should go live in our next wave of updates to production in the next day or so. |
mairaw
added a commit
that referenced
this pull request
Sep 23, 2017
* Typo in document - IOne instead of One (#3202) Typo in document - IOne instead of One * Fix framework in dotnet store command topic (#3188) Reported by @pauliusnorkus. Thanks to @dasMulli for reminding me about the framework problem here. Using `netstandard2.0` worked during pre-release but no more. * Modified BindingOperations.EnableCollectionSynchronization overloads (#3153) * Modified BindingOperations.EnableCollectionSynchronization overloads * Some corrections to last overload * Incorporated review comments * Addressed review comments * Fixed bad xrefs * 90785 WebClient.Credentials property is cleared on redirect (#3087) * 90785 WebClient.Credentials property is cleared on redirect * Removing "or UseDefaultCredentials"; it's also cleared during redirects. * apply feedback * Added comment about virtual methods (#3105) * Added comment about virtual methods Added a line about not overriding virtual methods because of issues involved with it. * applying feedback * Fixed: Invalid example code (#3204) * Fixed wrong example code A large chunk of the the example code in 'Listening by Registering a Callback' section had nothing to do with registering a callback. I added a small but complete example of using the CancellationToken.Register method. * Fixed wrong example code A large chunk of the the example code in 'Listening by Registering a Callback' section had nothing to do with registering a callback. I added a small but complete example of using the CancellationToken.Register method. (I submitted an equivalent change proposal for the C# example). * Problem of round-tripping Double values (#3101) * Problem of round-tripping Double values * Addressed review comments, revised Single documentation * Incorporated reviewer comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Title
Added comment on virtual methods
Summary
Added comment about using HttpMessageHandler instead of overriding virtual methods when extending the class.
Suggested Reviewers
@davidsh @karelz