[GitHub] [flink] jiasheng55 opened a new pull request #10323: [FLINK-14817][doc] Fix misleading documentation using method chaining…

[GitBox <gi...@apache.org>]

jiasheng55 opened a new pull request #10323: [FLINK-14817][doc] Fix misleading documentation using method chaining…
URL: https://github.com/apache/flink/pull/10323
 
 
   … of Configuration
   
   ## What is the purpose of the change
   
   In the document, there are some misleading code examples, e.g.
   
   ```
   // instantiate table environment
   TableEnvironment tEnv = ...tEnv.getConfig()        // access high-level configuration
     .getConfiguration()   // set low-level key-value options
     .setString("table.exec.mini-batch.enabled", "true")  // enable mini-batch optimization
     .setString("table.exec.mini-batch.allow-latency", "5 s") // use 5 seconds to buffer input records
     .setString("table.exec.mini-batch.size", "5000"); // the maximum number of records can be buffered by each aggregate operator task
   ```
   It seems `Configuration` supports method chaining, while it's not true since the return type of `Configuration#setString` is Void.
   
   This PR updates the documentation to fix this.
   
   ## Brief change log
   
     - Break the chaining call of `Documentation#setXXX`
   
   ## Verifying this change
   
   This change is a trivial rework without any test coverage.
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (no)
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
     - The serializers: (no)
     - The runtime per-record code paths (performance sensitive): (no)
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
     - The S3 file system connector: (no)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (no)

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services