chore: documentation and PR comments

microsoft · Dec 4, 2023 · 2d53710 · 2d53710
1 parent 2fbdc7d
commit 2d53710
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
@@ -1124,7 +1124,7 @@ export class RushConfiguration {
     readonly _rushPluginsConfiguration: RushPluginsConfiguration;
     readonly shrinkwrapFilename: string;
     get shrinkwrapFilePhrase(): string;
-    // Warning: (ae-incompatible-release-tags) The symbol "subspaceConfiguration" is marked as @public, but its signature references "SubspaceConfiguration" which is marked as @beta
+    // @beta
     readonly subspaceConfiguration?: SubspaceConfiguration;
     get subspaceNames(): string[];
     readonly subspaceShrinkwrapFilenames: (subspaceName: string) => string;

diff --git a/libraries/rush-lib/src/api/RushConfiguration.ts b/libraries/rush-lib/src/api/RushConfiguration.ts
@@ -374,6 +374,7 @@ export class RushConfiguration {
 
   /**
    * The object that specifies subspace configurations if they are provided in the rush workspace.
+   * @beta
    */
   public readonly subspaceConfiguration?: SubspaceConfiguration;
 

diff --git a/libraries/rush-lib/src/api/SubspaceConfiguration.ts b/libraries/rush-lib/src/api/SubspaceConfiguration.ts
@@ -11,13 +11,17 @@ export interface ISubspaceConfig {
 }
 
 /**
+ * (DEPRECATED)
+ *
  * This represents the JSON data structure for the "subspace.json" configuration file.
- * See subspace.schema.json for documentation.
+ * See subspace.schema.json for documentation. Includes the depreciated splitWorkspaceCompatibility property
+ * used to help migrate workspaces from a split-workspace state.
+ *
  */
 export interface ISubspaceConfigurationJson {
   $schema: string;
   enabled: boolean;
-  depreciatedTTSupport?: boolean;
+  splitWorkspaceCompatibility?: boolean;
   availableSubspaces: ISubspaceConfig;
 }
 

diff --git a/libraries/rush-lib/src/schemas/subspace.schema.json b/libraries/rush-lib/src/schemas/subspace.schema.json
@@ -13,8 +13,8 @@
       "description": "If true, rush will use the subspaces configuration",
       "type": "boolean"
     },
-    "depreciated_tt_support": {
-      "description": "A depreciated option that allows individual subspaces to be configured at the package level if that package is the only project in the subspace.",
+    "splitWorkspaceCompatibility": {
+      "description": "(DEPRECATED) A depreciated option that allows individual subspaces to be configured at the package level if that package is the only project in the subspace. Used to help migrate from a split workspace state.",
       "type": "boolean"
     },
     "availableSubspaces": {
-Original file line number
+Diff line change
@@ Expand Up / @@ -374,6 +374,7 @@ export class RushConfiguration { @@
       /**
        * The object that specifies subspace configurations if they are provided in the rush workspace.
+       * @beta
        */
       public readonly subspaceConfiguration?: SubspaceConfiguration;
@@ Expand Down @@