Skip to content

Commit e2d26a2

Browse files
authored
Merge pull request #17172 from susiwen8/fix-comment
chore: remove some unintentional comment
2 parents 4c167a3 + 734cfbf commit e2d26a2

File tree

5 files changed

+9
-15
lines changed

5 files changed

+9
-15
lines changed

src/chart/treemap/TreemapSeries.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -336,12 +336,6 @@ class TreemapSeriesModel extends SeriesModel<TreemapSeriesOption> {
336336
levels: [] // Each item: {
337337
// visibleMin, itemStyle, visualDimension, label
338338
// }
339-
// data: {
340-
// value: [],
341-
// children: [],
342-
// link: 'http://xxx.xxx.xxx',
343-
// target: 'blank' or 'self'
344-
// }
345339
};
346340

347341
/**

src/model/Global.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -682,7 +682,7 @@ echarts.use([${seriesImportName}]);`);
682682
* });
683683
* eachComponent(function (componentType, model, index) {
684684
* // componentType does not include subType
685-
* // (componentType is 'xxx' but not 'xxx.aa')
685+
* // (componentType is 'a' but not 'a.b')
686686
* });
687687
* eachComponent(
688688
* {mainType: 'dataZoom', query: {dataZoomId: 'abc'}},

src/model/Model.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ class Model<Opt = ModelOption> { // TODO: TYPE use unknown instead of any?
103103
get<R extends keyof Opt, S extends keyof Opt[R], T extends keyof Opt[R][S]>(
104104
path: readonly [R, S, T], ignoreParent?: boolean
105105
): Opt[R][S][T];
106-
// `path` can be 'xxx.yyy.zzz', so the return value type have to be `ModelOption`
106+
// `path` can be 'a.b.c', so the return value type have to be `ModelOption`
107107
// TODO: TYPE strict key check?
108108
// get(path: string | string[], ignoreParent?: boolean): ModelOption;
109109
get(path: string | readonly string[], ignoreParent?: boolean): ModelOption {
@@ -149,9 +149,9 @@ class Model<Opt = ModelOption> { // TODO: TYPE use unknown instead of any?
149149
getModel<R extends keyof Opt, S extends keyof Opt[R], T extends keyof Opt[R][S]>(
150150
path: readonly [R, S, T], parentModel?: Model
151151
): Model<Opt[R][S][T]>;
152-
// `path` can be 'xxx.yyy.zzz', so the return value type have to be `Model<ModelOption>`
152+
// `path` can be 'a.b.c', so the return value type have to be `Model<ModelOption>`
153153
// getModel(path: string | string[], parentModel?: Model): Model;
154-
// TODO 'xxx.yyy.zzz' is deprecated
154+
// TODO 'a.b.c' is deprecated
155155
getModel(path: string | readonly string[], parentModel?: Model): Model<any> {
156156
const hasPath = path != null;
157157
const pathFinal = hasPath ? this.parsePath(path) : null;

src/util/clazz.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ export function enableClassManagement(
231231
* Component model classes
232232
* key: componentType,
233233
* value:
234-
* componentClass, when componentType is 'xxx'
235-
* or Object.<subKey, componentClass>, when componentType is 'xxx.yy'
234+
* componentClass, when componentType is 'a'
235+
* or Object.<subKey, componentClass>, when componentType is 'a.b'
236236
*/
237237
const storage: {
238238
[componentMainType: string]: (Constructor | SubclassContainer)

src/util/types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,16 @@ export type ZRStyleProps = PathStyleProps | ImageStyleProps | TSpanStyleProps |
8787
export type ZRElementEventName = ElementEventName | 'globalout';
8888

8989
// ComponentFullType can be:
90-
// 'xxx.yyy': means ComponentMainType.ComponentSubType.
91-
// 'xxx': means ComponentMainType.
90+
// 'a.b': means ComponentMainType.ComponentSubType.
91+
// 'a': means ComponentMainType.
9292
// See `checkClassType` check the restict definition.
9393
export type ComponentFullType = string;
9494
export type ComponentMainType = keyof ECUnitOption & string;
9595
export type ComponentSubType = Exclude<ComponentOption['type'], undefined>;
9696
/**
9797
* Use `parseClassType` to parse componentType declaration to componentTypeInfo.
9898
* For example:
99-
* componentType declaration: 'xxx.yyy', get componentTypeInfo {main: 'xxx', sub: 'yyy'}.
99+
* componentType declaration: 'a.b', get componentTypeInfo {main: 'a', sub: 'b'}.
100100
* componentType declaration: '', get componentTypeInfo {main: '', sub: ''}.
101101
*/
102102
export interface ComponentTypeInfo {

0 commit comments

Comments
 (0)