You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "jroachgolf84 (via GitHub)" <gi...@apache.org> on 2026/10/09 16:54:52 UTC
[PR] Improve documentation on custom Operators in Airflow [airflow]
jroachgolf84 opened a new pull request, #74506:
URL: https://github.com/apache/airflow/pull/74506
## Description
Was referring a customer to the docs for custom Operators, and came across some language that could be improved. This doc enhances the instructions/documentation around creating a custom Operator.
No changes were made to the other parts of the doc.
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve documentation on custom Operators in Airflow [airflow]
Posted by "jroachgolf84 (via GitHub)" <gi...@apache.org>.
jroachgolf84 commented on PR #74506:
URL: https://github.com/apache/airflow/pull/74506#issuecomment-6182643903
@SameerMesiah97 - do you mind taking another look?
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve documentation on custom Operators in Airflow [airflow]
Posted by "jroachgolf84 (via GitHub)" <gi...@apache.org>.
jroachgolf84 commented on code in PR #74506:
URL: https://github.com/apache/airflow/pull/74506#discussion_r4271090574
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by extending (inheriting from) the public SDK base class :class:`~airflow.sdk.BaseOperator`.
-There are two methods that you need to override in a derived class:
+There are two methods that you need to override your custom operator:
-* Constructor - Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
+* Constructor (``__init__``): Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
Review Comment:
Yes, but let me take a look at this. I want to make sure these docs are accessible to folks, but I'm good to just replace with `__init__`.
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve documentation on custom Operators in Airflow [airflow]
Posted by "SameerMesiah97 (via GitHub)" <gi...@apache.org>.
SameerMesiah97 commented on code in PR #74506:
URL: https://github.com/apache/airflow/pull/74506#discussion_r4250714829
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by extending (inheriting from) the public SDK base class :class:`~airflow.sdk.BaseOperator`.
Review Comment:
```suggestion
You can create your own, custom operator by inheriting from the public SDK base class :class:`~airflow.sdk.BaseOperator`.
```
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by extending (inheriting from) the public SDK base class :class:`~airflow.sdk.BaseOperator`.
-There are two methods that you need to override in a derived class:
+There are two methods that you need to override your custom operator:
-* Constructor - Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
+* Constructor (``__init__``): Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
Review Comment:
Isn't it self-evident that `__init__` is the constructor? You could just leave it at Constructor or just replace constructor with just `__init__`. Latter would be better to make it consistent with line 34.
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by extending (inheriting from) the public SDK base class :class:`~airflow.sdk.BaseOperator`.
-There are two methods that you need to override in a derived class:
+There are two methods that you need to override your custom operator:
Review Comment:
```suggestion
There are two methods that you need to override in your custom operator:
```
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve documentation on custom Operators in Airflow [airflow]
Posted by "jroachgolf84 (via GitHub)" <gi...@apache.org>.
jroachgolf84 commented on code in PR #74506:
URL: https://github.com/apache/airflow/pull/74506#discussion_r4271124947
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by extending (inheriting from) the public SDK base class :class:`~airflow.sdk.BaseOperator`.
-There are two methods that you need to override in a derived class:
+There are two methods that you need to override your custom operator:
-* Constructor - Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
+* Constructor (``__init__``): Define the parameters required for the operator. You only need to specify the arguments specific to your operator.
Review Comment:
Fixed!
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Improve documentation on custom Operators in Airflow [airflow]
Posted by "SameerMesiah97 (via GitHub)" <gi...@apache.org>.
SameerMesiah97 commented on code in PR #74506:
URL: https://github.com/apache/airflow/pull/74506#discussion_r4287160222
##########
airflow-core/docs/howto/custom-operator.rst:
##########
@@ -24,14 +24,14 @@ Creating a custom Operator
Airflow allows you to create new operators to suit the requirements of you or your team.
This extensibility is one of the many features which make Apache Airflow powerful.
-You can create any operator you want by extending the public SDK base class :class:`~airflow.sdk.BaseOperator`.
+You can create your own, custom operator by inheriting from the public SDK base class :class:`~airflow.sdk.BaseOperator`.
Review Comment:
```suggestion
You can create your own custom operator by inheriting from the public SDK base class :class:`~airflow.sdk.BaseOperator`.
```
--
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@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org