kristynsmith commented on code in PR #35656: URL: https://github.com/apache/beam/pull/35656#discussion_r2257792046
########## sdks/python/apache_beam/internal/code_object_pickler.py: ########## @@ -15,7 +15,421 @@ # limitations under the License. # +"""Customizations to how Python code objects are pickled. + +This module provides functions for pickling code objects, especially lambdas, +in a consistent way. It addresses issues with non-deterministic pickling by +creating a unique identifier that is invariant to small changes in the source +code. + +The code object identifiers consists of a sequence of the following parts Review Comment: i disagree. the docstring for the module contains relevant information for the entire module, not just for get_code_path. moving some of this information to get_code_path would keep it from being perceived within the full context of the module. including only the relevant information to call get_code_path is best practices for docstrings: go/pystyle#function-docs. i added some examples of the code paths for additional context, but i don't think including any other information would be necessary. -- 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: github-unsubscr...@beam.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
