.NET Core breaking changes #12805
.NET Core breaking changes #12805
Conversation
There was a problem hiding this comment.
LGTM @rpetrusha. Left some comments for you to consider.
I'll do a new review after some of the changes I've requested are implemented.
| ms.date: 06/10/2019 | ||
| --- | ||
| # Breaking change categories | ||
|
|
There was a problem hiding this comment.
should you add an intro saying what this article is about?
|
|
||
| A particular change can affect compatiiblity in a number of ways. These fall into five categories: | ||
|
|
||
| ## Behavioral change |
There was a problem hiding this comment.
should this be a numbered list instead?
|
There are also some warnings on the build report that you should take a look. |
Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
|
Docs Build status updates of commit 371ed58: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
| @@ -0,0 +1,43 @@ | |||
| --- | |||
| title: Breaking change categories - .NET Core | |||
There was a problem hiding this comment.
Don't need the - .NET Core on the title.
There was a problem hiding this comment.
Yes, it's better to have @Thraka - that's why I suggested to add it. It's part of the SEO guidelines to have a brand suffix.
https://review.docs.microsoft.com/en-us/new-hope/quality/catstestcases/seo-rule?branch=master#title-metadata---title-suffix
There was a problem hiding this comment.
I'm confused then 😄 I thought this is automatically appended via the docfx file??
There was a problem hiding this comment.
Depends on the section of the docs. Not for every folder.
|
This is ready for another review, @mairaw. |
There was a problem hiding this comment.
Looks good @rpetrusha but left a few more suggestions for you before you merge
| --- | ||
| # Breaking change categories | ||
|
|
||
| *Compatibility* refers to the ability to compile or execute code on a version of a .NET implementation other than the one with which the code was originally developed. Changes between versions can affect compatibility in A particular change can affect compatibility in six different ways. The [individual kinds of changes that are considered when evaluating compatibility](index.md) fall into the first five categories. These are: |
There was a problem hiding this comment.
can affect compatibility in A particular change -> it seems you forgot part of the sentence here?
|
|
||
| 6. Forward compatibility | ||
|
|
||
| Forward compatibility refers to the ability of an existing consumer of an API to run against and behave the way as an older version. If a consumer is not able to run or behaves differently against an older version of the API, the API is *forward incompatible*. |
There was a problem hiding this comment.
"behave the way as an older version" reads a bit funny
|
|
||
| *Compatibility* refers to the ability to compile or execute code on a version of a .NET implementation other than the one with which the code was originally developed. Changes between versions can affect compatibility in A particular change can affect compatibility in six different ways. The [individual kinds of changes that are considered when evaluating compatibility](index.md) fall into the first five categories. These are: | ||
|
|
||
| 1. Behavioral change |
There was a problem hiding this comment.
wondering if it would be better to have these as H2s
|
|
||
| - It breaks late-bound scenarios such as the late binding feature in Visual Basic and [dynamic](../../csharp/language-reference/keywords/dynamic.md) in C#. | ||
|
|
||
| - It breaks [source compatibility](categories.md#source-compatibility) when developers use [named arguments](../../csharp/programming-guide/classes-and-structs/named-and-optional-arguments.md#named-arguments). |
Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
|
Thanks for the thorough review once again, @mairaw! |
.NET Core breaking changes
Fixes #11566
//cc @terrajobst