eladkal commented on code in PR #37075: URL: https://github.com/apache/airflow/pull/37075#discussion_r1469998144
########## docs/apache-airflow-providers/core-extensions/deprecations.rst: ########## @@ -0,0 +1,57 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Deprecations +========================================== + +This is a summary of deprecated objects in Apache Airflow Providers Packages. + +.. note:: + At the moment we only show deprecations for classes, functions, methods, properties etc. + Support for an argument deprecation or an argument value deprecation will be added in the future. + + +.. important:: + Only deprecations made with @deprecated decorator are included in this docs. + If You use warnings.warn in function/method body it will not show up in this documentation. + Make sure to use @deprecated decorator as shown in the below example: Review Comment: It should be in some contributor facing doc but I think it's better to find a way to enforce it rather than documenting it (for example: pre-commit that verify that all deprecations must be in the method you set as expected) For example: We added pre-commit that verifies in providers we use only `AirflowProviderDeprecationWarning` so we may need another pre-commit to verify the method this `AirflowProviderDeprecationWarning` is being used. https://github.com/apache/airflow/blob/48158c9967c14acf65264e338b8dea60af3f25e1/.pre-commit-config.yaml#L517-L521 -- 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-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
