This is an automated email from the ASF dual-hosted git repository.
yhu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 18d9b21cf3e DoFn lifecycle JavaDoc update. (#26122)
18d9b21cf3e is described below
commit 18d9b21cf3e43ee582f3214c7e390490d2dfa07f
Author: Svetak Sundhar <[email protected]>
AuthorDate: Wed Apr 5 14:09:18 2023 -0400
DoFn lifecycle JavaDoc update. (#26122)
* DoFn lifecycle JavaDoc update.
* Update website/www/site/content/en/documentation/programming-guide.md
* DoFn lifecycle JavaDoc update.
---------
Co-authored-by: Yi Hu <[email protected]>
---
website/www/site/content/en/documentation/programming-guide.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/website/www/site/content/en/documentation/programming-guide.md
b/website/www/site/content/en/documentation/programming-guide.md
index fc259f9cb81..6d69bd88482 100644
--- a/website/www/site/content/en/documentation/programming-guide.md
+++ b/website/www/site/content/en/documentation/programming-guide.md
@@ -1195,7 +1195,10 @@ Here is a sequence diagram that shows the lifecycle of
the DoFn during
the execution of the ParDo transform. The comments give useful
information to pipeline developers such as the constraints that
apply to the objects or particular cases such as failover or
- instance reuse. They also give instantiation use cases.
+ instance reuse. They also give instantiation use cases. Two key points
+ to note are that (1) teardown is done on a best effort basis and thus
+ isn't guaranteed and (2) the number of DoFn instances is runner
+ dependent.
<!-- The source for the sequence diagram can be found in the SVG resource. -->
