HeartSaVioR commented on PR #37893: URL: https://github.com/apache/spark/pull/37893#issuecomment-1252277251
I tried to add method level doc as many as possible, except the case I think it's unnecessary (I might still miss some pieces). I don't go with the approach trying to explain all of the parameters with types though, for reasons: - For Python code, it'd be really hard to maintain the doc in sync with the code. - For Scala/Java we have been omitting the explanation of parameters or even methods if it's obvious from the name. In both languages, we strongly encourage to have method doc and parameter explanation for public APIs. Here we technically add only one public method in group_ops, and one public class GroupState in PySpark. Others are all internal and private. -- 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: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
