Sankey chart (2 of 2): doc updates only

packages/react-charts/src/victory/components/Chart/Chart.tsx

@@ -94,14 +94,14 @@ export interface ChartProps extends VictoryChartProps {
   /**
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   defaultAxes?: AxesType;
   /**
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   defaultPolarAxes?: AxesType;
@@ -348,7 +348,7 @@ export interface ChartProps extends VictoryChartProps {
   /**
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   prependDefaultAxes?: boolean;
@@ -391,7 +391,7 @@ export interface ChartProps extends VictoryChartProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartArea/ChartArea.tsx

@@ -311,7 +311,7 @@ export interface ChartAreaProps extends VictoryAreaProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartArea/examples/ChartArea.md

@@ -18,7 +18,7 @@ import { getResizeObserver } from '@patternfly/react-core';
 ## Introduction
 Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
 
-PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
+The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
 
 ## Examples
 ### Basic with right aligned legend

packages/react-charts/src/victory/components/ChartAxis/ChartAxis.tsx

@@ -305,7 +305,7 @@ export interface ChartAxisProps extends VictoryAxisProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartBar/ChartBar.tsx

@@ -306,7 +306,7 @@ export interface ChartBarProps extends VictoryBarProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   polar?: boolean;
@@ -350,7 +350,7 @@ export interface ChartBarProps extends VictoryBarProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartBar/examples/ChartBar.md

@@ -15,7 +15,7 @@ import t_global_color_status_warning_100 from '@patternfly/react-tokens/dist/esm
 
 Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
 
-PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
+The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
 
 ## Examples
 

packages/react-charts/src/victory/components/ChartBoxPlot/ChartBoxPlot.tsx

@@ -425,7 +425,7 @@ export interface ChartBoxPlotProps extends VictoryBoxPlotProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   polar?: boolean;
@@ -559,7 +559,7 @@ export interface ChartBoxPlotProps extends VictoryBoxPlotProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartBoxPlot/examples/ChartBoxPlot.md

@@ -19,7 +19,7 @@ import chart_color_orange_300 from '@patternfly/react-tokens/dist/esm/chart_colo
 ## Introduction
 Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
 
-PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
+The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
 
 
 ## Examples

packages/react-charts/src/victory/components/ChartBullet/examples/ChartBullet.md

@@ -16,7 +16,7 @@ import { getResizeObserver } from '@patternfly/react-core';
 ## Introduction
 Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
 
-PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
+The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
 
 ## Examples
 ### Basic

packages/react-charts/src/victory/components/ChartBullet/utils/chart-bullet-data.ts

@@ -22,7 +22,8 @@ interface ChartBulletDataInterface {
 
 /**
  * Returns comparative measure data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeMeasureData = ({
   data,
@@ -54,7 +55,8 @@ export const getComparativeMeasureData = ({
 
 /**
  * Returns comparative error measure data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeErrorMeasureData = ({
   data,
@@ -73,7 +75,8 @@ export const getComparativeErrorMeasureData = ({
 
 /**
  * Returns comparative warning data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeWarningMeasureData = ({
   data,
@@ -92,7 +95,8 @@ export const getComparativeWarningMeasureData = ({
 
 /**
  * Returns primary dot measure data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getPrimaryDotMeasureData = ({
   data,
@@ -115,7 +119,8 @@ export const getPrimaryDotMeasureData = ({
 
 /**
  * Returns primary segment measure data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getPrimarySegmentedMeasureData = ({
   data,
@@ -182,7 +187,8 @@ export const getPrimarySegmentedMeasureData = ({
 
 /**
  * Returns qualitative range data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getQualitativeRangeData = ({
   data,

packages/react-charts/src/victory/components/ChartBullet/utils/chart-bullet-domain.ts

@@ -17,7 +17,8 @@ interface ChartBulletDomainInterface {
 
 /**
  * Returns the bullet chart's min and max domain for comparative / primary measures and qualitative range data
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getBulletDomain = ({
   comparativeErrorMeasureComponent,

packages/react-charts/src/victory/components/ChartBullet/utils/chart-bullet-size.ts

@@ -20,7 +20,8 @@ interface ChartBulletScaleInterface {
 
 /**
  * Scale dimensions
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 const scaleDimensions = ({
   defaultSize,
@@ -42,13 +43,15 @@ const scaleDimensions = ({
 
 /**
  * Scale bar width per the given size properties
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 const scaleBarWidth = (props: ChartBulletScaleInterface) => Math.max(scaleDimensions(props), 0);
 
 /**
  * Scale size per the given size properties
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 const scaleSize = ({ value, ...rest }: ChartBulletScaleInterface) =>
   Math.round(
@@ -69,7 +72,8 @@ interface ChartBulletSizeInterface {
 
 /**
  * Scale size per the given size properties
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeMeasureErrorWidth = ({
   height,
@@ -90,7 +94,8 @@ export const getComparativeMeasureErrorWidth = ({
 
 /**
  * Returns comparative measure width
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeMeasureWidth = ({
   height,
@@ -111,7 +116,8 @@ export const getComparativeMeasureWidth = ({
 
 /**
  * Returns comparative measure warning width
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getComparativeMeasureWarningWidth = ({
   height,
@@ -132,7 +138,8 @@ export const getComparativeMeasureWarningWidth = ({
 
 /**
  * Returns primary dot measure size
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getPrimaryDotMeasureSize = ({
   height,
@@ -153,7 +160,8 @@ export const getPrimaryDotMeasureSize = ({
 
 /**
  * Returns primary segmented measure width
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getPrimarySegmentedMeasureWidth = ({
   height,
@@ -175,7 +183,8 @@ export const getPrimarySegmentedMeasureWidth = ({
 
 /**
  * Returns qualitative range bar width
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getQualitativeRangeBarWidth = ({
   height,

packages/react-charts/src/victory/components/ChartBullet/utils/chart-bullet-theme.ts

@@ -27,7 +27,8 @@ interface ChartBulletThemeInterface {
 
 /**
  * Returns legend color scale
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 const getLegendColorScale = (computedData: any, legendData: any) => {
   const colorScale: string[] = [];
@@ -43,7 +44,8 @@ const getLegendColorScale = (computedData: any, legendData: any) => {
 
 /**
  * Returns color scale
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getColorScale = ({
   comparativeErrorMeasureData,
@@ -103,7 +105,8 @@ export const getColorScale = ({
 
 /**
  * Returns bullet chart theme with legend color scale
- * @private
+ *
+ * @private Not intended as public API and subject to change
  */
 export const getBulletThemeWithLegendColorScale = ({
   comparativeErrorMeasureData,

packages/react-charts/src/victory/components/ChartContainer/ChartContainer.tsx

@@ -74,7 +74,7 @@ export interface ChartContainerProps extends VictoryContainerProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   polar?: boolean;

packages/react-charts/src/victory/components/ChartCursorContainer/ChartCursorContainer.tsx

@@ -27,7 +27,7 @@ export interface ChartCursorContainerProps extends VictoryCursorContainerProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   children?: React.ReactElement<any> | React.ReactElement<any>[];
@@ -138,7 +138,7 @@ export interface ChartCursorContainerProps extends VictoryCursorContainerProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   polar?: boolean;

packages/react-charts/src/victory/components/ChartCursorTooltip/ChartCursorTooltip.tsx

@@ -143,7 +143,7 @@ export interface ChartCursorTooltipProps extends ChartTooltipProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   height?: number;
@@ -249,7 +249,7 @@ export interface ChartCursorTooltipProps extends ChartTooltipProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   width?: number;

packages/react-charts/src/victory/components/ChartDonut/ChartDonut.tsx

@@ -402,7 +402,7 @@ export interface ChartDonutProps extends ChartPieProps {
    *
    * Note: This prop should not be set manually.
    *
-   * @private
+   * @private Not intended as public API and subject to change
    * @hide
    */
   sharedEvents?: { events: any[]; getEventState: Function };

packages/react-charts/src/victory/components/ChartDonut/examples/ChartDonut.md

@@ -12,7 +12,7 @@ import { ChartDonut, ChartThemeColor } from '@patternfly/react-charts/victory';
 ## Introduction
 Note: PatternFly React charts live in its own package at [@patternfly/react-charts](https://www.npmjs.com/package/@patternfly/react-charts)!
 
-PatternFly React charts are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
+The examples below are based on the [Victory](https://formidable.com/open-source/victory/docs/victory-chart/) chart library, along with additional functionality, custom components, and theming for PatternFly. This provides a collection of React based components you can use to build PatternFly patterns with consistent markup, styling, and behavior.
 
 ## Examples
 ### Basic