zero323 commented on a change in pull request #30181:
URL: https://github.com/apache/spark/pull/30181#discussion_r517314341
##########
File path: python/pyspark/sql/avro/functions.py
##########
@@ -25,7 +25,6 @@
from pyspark.util import _print_missing_jar
-@since(3.0)
Review comment:
I've been looking at numpydoc documentation and it seems like the
preferred order of sections is
> 1 Short summary
> 2 Deprecation warning
> 3 Extended Summary
> ...
> 13 Notes
> ...
> 15 Examples
with no dedicated section for `versionadded`.
If so, shall we standardize things a bit and try something around
1. Short summary
2. Extended Summary (optional)
3. Version added (optional)
4. Deprecation warning (optional)
...
This should match `@since`-annotated code and make things consistent across
documentation (at the moment `New in version` is sometimes placed after
examples and doesn't look good in the rendered docs).
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
