He-Pin opened a new pull request, #3678: URL: https://github.com/apache/pekko/pull/3678
### Motivation `docs/src/main/paradox/stream/operators/index.md` is generated in place by `project/StreamOperatorsIndexGenerator` whenever `docs/paradox` runs - its first line says `<!-- DO NOT EDIT DIRECTLY: This file is generated by project/StreamOperatorsIndexGenerator -->`. The committed copy had drifted from the current Scaladoc of the stream operators, so any local `sbt docs/paradox` leaves the working tree dirty with 12 changed lines. Nothing in CI catches this: the `Generate doc check` job runs `sbt ";+TestJdk21 / compile ; +compile:doc"`, which never compares the generated index against the committed one. I noticed this while running `docs/paradox` for #3677. ### Modification Commit the regenerated file. The only differences are operator descriptions picked up from the current Scaladoc, for example: * `a new Sink that can be consume elements 'into' the pre-materialized one` -> `a new Sink that can consume elements ...` * `as it pass through this processing step` -> `as it passes through this processing step` * `the Java 8 Collector transformation` -> `the Java Collector transformation` No operator was added or removed, and no other generated docs file changed. ### Result The committed index matches what the generator produces from the current sources, so running `docs/paradox` no longer dirties this file. ### Tests Not run - docs only. `sbt docs/paradox` was run on this branch: it regenerated exactly this content and left the file unchanged afterwards, which is what confirms the index is now in sync with the sources. `git diff --check`: passed. ### References None - generated-file drift noticed while running `docs/paradox` for #3677 -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
