diff --git a/reference_guide/api_changes_list.md b/reference_guide/api_changes_list.md index 88f564c62..d0b084a60 100644 --- a/reference_guide/api_changes_list.md +++ b/reference_guide/api_changes_list.md @@ -13,7 +13,7 @@ To document a new incompatible change, add a new line with the problem pattern f and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2019.md b/reference_guide/api_changes_list_2019.md index 874978a3d..23036512c 100644 --- a/reference_guide/api_changes_list_2019.md +++ b/reference_guide/api_changes_list_2019.md @@ -8,10 +8,10 @@ Before documenting a breaking API change, please make sure that the change canno APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description -and recommended fix/action (please write full sentence ending with '.', see existing entries as reference). +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2020.md b/reference_guide/api_changes_list_2020.md index de874a828..ac3b96fd0 100644 --- a/reference_guide/api_changes_list_2020.md +++ b/reference_guide/api_changes_list_2020.md @@ -8,10 +8,10 @@ Before documenting a breaking API change, please make sure that the change canno APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description -and recommended fix/action (please write full sentence ending with '.', see existing entries as reference). +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2021.md b/reference_guide/api_changes_list_2021.md index 459c7a6b2..05a204d85 100644 --- a/reference_guide/api_changes_list_2021.md +++ b/reference_guide/api_changes_list_2021.md @@ -8,10 +8,10 @@ Before documenting a breaking API change, please make sure that the change canno APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description -and recommended fix/action (please write full sentence ending with '.', see existing entries as reference). +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2022.md b/reference_guide/api_changes_list_2022.md index c5b94b6be..8c793e3c4 100644 --- a/reference_guide/api_changes_list_2022.md +++ b/reference_guide/api_changes_list_2022.md @@ -8,10 +8,10 @@ Before documenting a breaking API change, please make sure that the change canno APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description -and recommended fix/action (please write full sentence ending with '.', see existing entries as reference). +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2023.md b/reference_guide/api_changes_list_2023.md index e36d37868..d3e654ee4 100644 --- a/reference_guide/api_changes_list_2023.md +++ b/reference_guide/api_changes_list_2023.md @@ -8,10 +8,10 @@ Before documenting a breaking API change, please make sure that the change canno APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description -and recommended fix/action (please write full sentence ending with '.', see existing entries as reference). +and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed diff --git a/reference_guide/api_changes_list_2024.md b/reference_guide/api_changes_list_2024.md index d50ce53d8..9a923a241 100644 --- a/reference_guide/api_changes_list_2024.md +++ b/reference_guide/api_changes_list_2024.md @@ -11,7 +11,7 @@ To document a new incompatible change, add a new line with the problem pattern f and recommended fix/action (REQUIRED, please write full sentence ending with '.', see existing entries as reference). Non-platform changes must be grouped under relevant section for plugin. -The following problem patterns are supported and must be followed EXACTLY: +The following problem patterns are supported and must be followed EXACTLY (e.g., no '#' instead of '.'): package removed @@ -135,7 +135,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no Class `com.intellij.diff.editor.DiffVirtualFile` now extends `com.intellij.diff.editor.DiffViewerVirtualFile` and inherits its abstract method `com.intellij.diff.editor.DiffViewerVirtualFile.createViewer(Project)` : Update code usages. -`com.intellij.diff.tools.combined.CombinedDiffVirtualFile.getSourceId()` method removed. +`com.intellij.diff.tools.combined.CombinedDiffVirtualFile.getSourceId()` method removed : Update code usages. `com.intellij.diff.tools.combined.CombinedDiffModel` interface removed