josh-fell commented on code in PR #29143:
URL: https://github.com/apache/airflow/pull/29143#discussion_r1086144868


##########
docs/apache-airflow/howto/operator/python.rst:
##########
@@ -225,11 +225,29 @@ Jinja templating can be used in same way as described for 
the PythonOperator.
 PythonSensor
 ============
 
-Use the :class:`~airflow.sensors.python.PythonSensor` to use arbitrary 
callable for sensing. The callable
-should return True when it succeeds, False otherwise.
+A PythonSensor waits for a certain condition to be ``True``, for example to 
wait for a file to exist. The
+PythonSensor is available via ``@task.sensor`` and 
``airflow.sensors.python.PythonSensor``. The callable
+should return a boolean ``True`` or ``False``, indicating whether a condition 
is met. For example:

Review Comment:
   _Technically_ ~the `PythonSensor`~ they both can also return ~the truthy or 
falsy~ a non-boolean value via `PokeReturnValue` ~and, interestingly enough, 
[this PR](https://github.com/apache/airflow/pull/29146) was opened to mimic the 
same behavior in `@task.sensor`~.
   
   Not sure if you want to dive into this nuance here.
   
   edit: Oh boy Josh, you really didn't do your homework on that comment 🤦 



-- 
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

Reply via email to