Hisoka-X commented on code in PR #5255:
URL: https://github.com/apache/seatunnel/pull/5255#discussion_r1364790231


##########
docs/en/connector-v2/source/FakeSource.md:
##########
@@ -16,54 +16,53 @@ just for some test cases such as type conversion or 
connector new feature testin
 - [ ] [parallelism](../../concept/connector-v2-features.md)
 - [ ] [support user-defined split](../../concept/connector-v2-features.md)
 
-## Options
-
-|        name         |   type   | required |      default value      |
-|---------------------|----------|----------|-------------------------|
-| schema              | config   | yes      | -                       |
-| rows                | config   | no       | -                       |
-| row.num             | int      | no       | 5                       |
-| split.num           | int      | no       | 1                       |
-| split.read-interval | long     | no       | 1                       |
-| map.size            | int      | no       | 5                       |
-| array.size          | int      | no       | 5                       |
-| bytes.length        | int      | no       | 5                       |
-| string.length       | int      | no       | 5                       |
-| string.fake.mode    | string   | no       | range                   |
-| tinyint.fake.mode   | string   | no       | range                   |
-| tinyint.min         | tinyint  | no       | 0                       |
-| tinyint.max         | tinyint  | no       | 127                     |
-| tinyint.template    | list     | no       | -                       |
-| smallint.fake.mode  | string   | no       | range                   |
-| smallint.min        | smallint | no       | 0                       |
-| smallint.max        | smallint | no       | 32767                   |
-| smallint.template   | list     | no       | -                       |
-| int.fake.template   | string   | no       | range                   |
-| int.min             | int      | no       | 0                       |
-| int.max             | int      | no       | 0x7fffffff              |
-| int.template        | list     | no       | -                       |
-| bigint.fake.mode    | string   | no       | range                   |
-| bigint.min          | bigint   | no       | 0                       |
-| bigint.max          | bigint   | no       | 0x7fffffffffffffff      |
-| bigint.template     | list     | no       | -                       |
-| float.fake.mode     | string   | no       | range                   |
-| float.min           | float    | no       | 0                       |
-| float.max           | float    | no       | 0x1.fffffeP+127         |
-| float.template      | list     | no       | -                       |
-| double.fake.mode    | string   | no       | range                   |
-| double.min          | double   | no       | 0                       |
-| double.max          | double   | no       | 0x1.fffffffffffffP+1023 |
-| double.template     | list     | no       | -                       |
-| table-names         | list     | no       | -                       |
-| common-options      |          | no       | -                       |
-
-### schema [config]
-
-#### fields [Config]
-
-The schema of fake data that you want to generate
-
-#### Examples
+## Source Options
+
+|        Name         |   Type   | Required |         Default         |        
                                                                              
Description                                                                     
                 |
+|---------------------|----------|----------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| schema              | config   | yes      | -                       | Define 
Schema information                                                              
                                                                                
               |
+| rows                | config   | no       | -                       | The 
row list of fake data output per degree of parallelism                          
                                                                                
                  |
+| row.num             | int      | no       | 5                       | The 
total number of data generated per degree of parallelism                        
                                                                                
                  |
+| split.num           | int      | no       | 1                       | the 
number of splits generated by the enumerator for each degree of parallelism     
                                                                                
                  |
+| split.read-interval | long     | no       | 1                       | The 
interval(mills) between two split reads in a reader                             
                                                                                
                  |
+| map.size            | int      | no       | 5                       | The 
size of `map` type that connector generated                                     
                                                                                
                  |
+| array.size          | int      | no       | 5                       | The 
size of `array` type that connector generated                                   
                                                                                
                  |
+| bytes.length        | int      | no       | 5                       | The 
length of `bytes` type that connector generated                                 
                                                                                
                  |
+| string.length       | int      | no       | 5                       | The 
length of `string` type that connector generated                                
                                                                                
                  |
+| string.fake.mode    | string   | no       | range                   | The 
fake mode of generating string data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`string.template` option     |
+| string.template     | list     | no       | -                       | The 
template list of string type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                    |
+| tinyint.fake.mode   | string   | no       | range                   | The 
fake mode of generating tinyint data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`tinyint.template` option   |
+| tinyint.min         | tinyint  | no       | 0                       | The 
min value of tinyint data that connector generated                              
                                                                                
                  |
+| tinyint.max         | tinyint  | no       | 127                     | The 
max value of tinyint data that connector generated                              
                                                                                
                  |
+| tinyint.template    | list     | no       | -                       | The 
template list of tinyint type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                   |
+| smallint.fake.mode  | string   | no       | range                   | The 
fake mode of generating smallint data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`smallint.template` option |
+| smallint.min        | smallint | no       | 0                       | The 
min value of smallint data that connector generated                             
                                                                                
                  |
+| smallint.max        | smallint | no       | 32767                   | The 
max value of smallint data that connector generated                             
                                                                                
                  |
+| smallint.template   | list     | no       | -                       | The 
template list of smallint type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                  |
+| int.fake.template   | string   | no       | range                   | The 
fake mode of generating int data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`int.template` option           |
+| int.min             | int      | no       | 0                       | The 
min value of int data that connector generated                                  
                                                                                
                  |
+| int.max             | int      | no       | 0x7fffffff              | The 
max value of int data that connector generated                                  
                                                                                
                  |
+| int.template        | list     | no       | -                       | The 
template list of int type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                       |
+| bigint.fake.mode    | string   | no       | range                   | The 
fake mode of generating bigint data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`bigint.template` option     |
+| bigint.min          | bigint   | no       | 0                       | The 
min value of bigint data that connector generated                               
                                                                                
                  |
+| bigint.max          | bigint   | no       | 0x7fffffffffffffff      | The 
max value of bigint data that connector generated                               
                                                                                
                  |
+| bigint.template     | list     | no       | -                       | The 
template list of bigint type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                    |
+| float.fake.mode     | string   | no       | range                   | The 
fake mode of generating float data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`float.template` option       |
+| float.min           | float    | no       | 0                       | The 
min value of float data that connector generated                                
                                                                                
                  |
+| float.max           | float    | no       | 0x1.fffffeP+127         | The 
max value of float data that connector generated                                
                                                                                
                  |
+| float.template      | list     | no       | -                       | The 
template list of float type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                     |
+| double.fake.mode    | string   | no       | range                   | The 
fake mode of generating float data, support `range` and `template`, default 
`range`,if use configured it to `template`, user should also configured 
`double.template` option      |
+| double.min          | double   | no       | 0                       | The 
min value of double data that connector generated                               
                                                                                
                  |
+| double.max          | double   | no       | 0x1.fffffffffffffP+1023 | The 
max value of double data that connector generated                               
                                                                                
                  |
+| double.template     | list     | no       | -                       | The 
template list of double type that connector generated, if user configured it, 
connector will randomly select an item from the template list                   
                    |
+| table-names         | list     | no       | -                       | The 
Supports configuration of multiple data sources for example: ["test.table1", 
"test.table2"]                                                                  
                     |

Review Comment:
   Check the old one 
https://github.com/apache/seatunnel/pull/5255/files#diff-368d0e6bf6b91efe5c90ec4eaa163de7332b3e6e64797a0fc6b27dd3d0711326L266.
 You losted many important information in the new one description. 
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to