Update state doc 34905
Issue link: https://github.com/apache/beam/issues/34905
Updated Python State Doc to provide more clarity.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead. - [ ] Update
CHANGES.mdwith noteworthy changes. - [ ] If this contribution is large, please file an Apache Individual Contributor License Agreement.
See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.
@damccorm Were you thinking something similar?
There are a couple of more changes which I am going to add:
- Update programming doc for missing state(s).
- Add section in programming doc for utility function such as passing window, timer and other parameter in the timer callback function.
let me know if you have something else in mind as well.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 56.46%. Comparing base (
d427d37) to head (c312d9e). Report is 184 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #35209 +/- ##
============================================
- Coverage 56.49% 56.46% -0.04%
Complexity 3301 3301
============================================
Files 1182 1189 +7
Lines 181610 182012 +402
Branches 3409 3409
============================================
+ Hits 102599 102771 +172
- Misses 75740 75970 +230
Partials 3271 3271
| Flag | Coverage Δ | |
|---|---|---|
| python | 80.91% <100.00%> (-0.21%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Assigning reviewers:
R: @tvalentyn for label python.
Note: If you would like to opt out of this review, comment assign to next reviewer.
Available commands:
stop reviewer notifications- opt out of the automated review toolingremind me after tests pass- tag the comment author after tests passwaiting on author- shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
also ptal at formatter & linter errors. thanks!
Run Python_Runners PreCommit 3.9
Run PythonDocs PreCommit
Run Prism_Python PreCommit 3.9