cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
8 stars 19 forks source link

Document queues better #691

Open hjoliver opened 4 months ago

hjoliver commented 4 months ago

I've had a few users confused about overlapping queue assignments. The current documentation is a bit too minimal.

The salient points:

Cylc can in principle support different types of queue, but at the moment we only have simple non-overlapping FIFO queues:

oliver-sanders commented 4 months ago

Suggest documenting this in the queue implementation docstring and autoducmenting it from cylc-doc.

We could also document the base class in the "plugins" section of the docs to assist with queue plugin development. Note we don't have an entry point for queues as yet.