[GitHub] [incubator-devlake] klesh commented on a diff in pull request #4626: docs: thorough godoc for StatefulApiCollectorForFinalizableEntity

["klesh (via GitHub)" <gi...@apache.org>]

klesh commented on code in PR #4626:
URL: https://github.com/apache/incubator-devlake/pull/4626#discussion_r1134802061


##########
backend/helpers/pluginhelper/api/api_collector_with_state.go:
##########
@@ -122,18 +122,25 @@ func (m *ApiCollectorStateManager) Execute() errors.Error {
 }
 
 // NewStatefulApiCollectorForFinalizableEntity aims to add timeFilter/diffSync support for
-// APIs that do NOT support filtering data by updated date. However, it comes with the
+// APIs that do NOT support filtering data by the updated date. However, it comes with the
 // following constraints:
 //  1. The entity is a short-lived object or it is likely to be irrelevant
 //     a. ci/id pipelines are short-lived objects
 //     b. pull request might took a year to be closed or never, but it is likely irrelevant
-//  2. The entity must be Finalizable: when it is finalized, no modification forever
+//  2. The entity must be Finalizable: when it is finalized, no modification would be allowed ever since

Review Comment:
   Updated



-- 
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: commits-unsubscribe@devlake.apache.org

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