Re: [PR] [FLINK-35177] Fix DataGen Connector documentation [flink]

2024-04-19 Thread via GitHub


flinkbot commented on PR #24692:
URL: https://github.com/apache/flink/pull/24692#issuecomment-2067479443

   
   ## CI report:
   
   * 4d0723dfc64326e5fab53b2b59c495f341a865df UNKNOWN
   
   
   Bot commands
 The @flinkbot bot supports the following commands:
   
- `@flinkbot run azure` re-run the last Azure build
   


-- 
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: issues-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[PR] [FLINK-35177] Fix DataGen Connector documentation [flink]

2024-04-19 Thread via GitHub


morozov opened a new pull request, #24692:
URL: https://github.com/apache/flink/pull/24692

   
   
   ## What is the purpose of the change
   
   The code 
[examples](https://nightlies.apache.org/flink/flink-docs-release-1.19/docs/connectors/datastream/datagen/#rate-limiting)
 used in the documentation are incorrect. Currently, they look like this:
   ```java
   GeneratorFunction generatorFunction = index -> index;
   double recordsPerSecond = 100;
   
   DataGeneratorSource source =
   new DataGeneratorSource<>(
generatorFunction,
Long.MAX_VALUE,
RateLimiterStrategy.perSecond(recordsPerSecond),
Types.STRING);
   ```
   
   The generator function returns `Long `but the `DataGeneratorSource` uses 
`String` and `Types.STRING`, so the types do not match, and the example code 
cannot be compiled.
   
   ## Brief change log
   
   The types used by the `DataGeneratorSource` are updated to match the return 
type of the generator function.
   
   ## Verifying this change
   
   Please make sure both new and modified tests in this PR follow [the 
conventions for tests defined in our code quality 
guide](https://flink.apache.org/how-to-contribute/code-style-and-quality-common/#7-testing).
   
   This change is a trivial rework / code cleanup 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, Kubernetes/Yarn, ZooKeeper: no
 - The S3 file system connector: no
   
   ## Documentation
   
 - Does this pull request introduce a new feature? no
 - If yes, how is the feature documented? not applicable
   


-- 
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: issues-unsubscr...@flink.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org