Skip to content

Commit

Permalink
fix blank lines in javadoc (#109980)
Browse files Browse the repository at this point in the history
Just fixed javadoc rendering for a class I was looking at.
  • Loading branch information
not-napoleon authored Jun 20, 2024
1 parent 1f76dee commit c709b78
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -122,29 +122,29 @@

/**
* CSV-based unit testing.
*
* <p>
* Queries and their result live *.csv-spec files.
* The results used in these files were manually added by running the same query on a real (debug mode) ES node. CsvTestsDataLoader loads
* the test data helping to get the said results.
*
* <p>
* CsvTestsDataLoader creates an index using the mapping in mapping-default.json. The same mapping file is also used to create the
* IndexResolver that helps validate the correctness of the query and the supported field data types.
* The created index and this class uses the data from employees.csv file as data. This class is creating one Page with Blocks in it using
* this file and the type of blocks matches the type of the schema specified on the first line of the csv file. These being said, the
* mapping in mapping-default.csv and employees.csv should be more or less in sync. An exception to this rule:
*
* <p>
* languages:integer,languages.long:long. The mapping has "long" as a sub-field of "languages". ES knows what to do with sub-field, but
* employees.csv is specifically defining "languages.long" as "long" and also has duplicated columns for these two.
*
* <p>
* ATM the first line from employees.csv file is not synchronized with the mapping itself.
*
* <p>
* When we add support for more field types, CsvTests should change to support the new Block types. Same goes for employees.csv file
* (the schema needs adjustment) and the mapping-default.json file (to add or change an existing field).
* When we add more operators, optimization rules to the logical or physical plan optimizers, there may be the need to change the operators
* in TestPhysicalOperationProviders or adjust TestPhysicalPlanOptimizer. For example, the TestPhysicalPlanOptimizer is skipping any
* rules that push operations to ES itself (a Limit for example). The TestPhysicalOperationProviders is a bit more complicated than that:
* it’s creating its own Source physical operator, aggregation operator (just a tiny bit of it) and field extract operator.
*
* <p>
* To log the results logResults() should return "true".
*/
// @TestLogging(value = "org.elasticsearch.xpack.esql:TRACE,org.elasticsearch.compute:TRACE", reason = "debug")
Expand Down

0 comments on commit c709b78

Please sign in to comment.