-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Update BREAKINGCHANGES.md to Include Web Cmdlets Breaking Changes #5852
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
Update BREAKINGCHANGES.md to Include Web Cmdlets Breaking Changes #5852
Conversation
docs/BREAKINGCHANGES.md
Outdated
|
|
||
| ### Changes to Web Cmdlets | ||
|
|
||
| The underlying .NET API of the Web Cmdlets has been changed to `System.Net.Http.HttpClient`. This change provides many benefits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use semantic line breaks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the end of the first sentence should be:
due to differences between .Net and CoreFx.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe - .Net Framework and .Net Core.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But that change actually doesn't have anything to do with .NET Core and .NET Framework? Unless I'm mistaken, WebRequest still exists in .NET Core. The decision to move to HttpClient appeared to be more about performance, code simplification, and it being a better fit for these cmdlets and nothing about any particular .NET Core limitations.
As for semantic line breaks.. after reading that document I have no clue what I need to do there. Sentences on separate lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@markekraus when the webcmdlets were initially ported, only dotnetcore 1.x was available and only HttpClient was available. This has changed with dotnetcore 2.0 and we didn't go back and revert the code change (remember we only moved to dotnetcore 2.0 for RC1). Maybe it doesn't matter to bring up history since it's no longer applicable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, good to know. What should I say here then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, meant beta
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@markekraus upon reflection, let's just leave it the way you wrote it except add a line break :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.
PR Summary
Document breaking changes in the Web Cmdlets due to switching .NET APIs and lack of IE interop.
WIP until I verify
.spelling.Reference ##5620
PR Checklist
Note: Please mark anything not applicable to this PR
NA.[feature]if the change is significant or affects feature testsWIP:to the beginning of the title and remove the prefix when the PR is ready.