search

PrefectHQ / prefect

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.
https://prefect.io
Apache License 2.0
17.23k stars 1.63k forks source link

prefect-shell: provide detail or change suggestion in example code #13072

Open discdiver opened 1 year ago

discdiver commented 1 year ago

In the main example code there is a comment that reads:

"# for long running operations, you can use a context manager"

Some guidance on the time frame and/or reason for this recommendation, if it still applies, would be helpful for the user.

egnor commented 1 year ago

My understanding is that it's not the length of time the process is running, rather, it's whether you want to be doing something else (in the same task) while the process is running. I think "long running" is a confusing way of describing "running while your other lines of code are executing".

But I could totally be wrong! I am just a noob user! (@sckott and I were just discussing this)

tyong920 commented 7 months ago

In the main example code there is a comment that reads:

"# for long running operations, you can use a context manager"

Some guidance on the time frame and/or reason for this recommendation, if it still applies, would be helpful for the user.

I couldn't agree more! The current description is quite confusing, and I eagerly await further clarification or examples. Thank you very much.