deck-chores icon indicating copy to clipboard operation
deck-chores copied to clipboard

Documentation Listing all registered jobs

Open M3ssman opened this issue 2 years ago • 3 comments

Description

The current Docs about Listing registerd Jobs does not tell where this information can be obtained.

Need to find and read closed issue https://github.com/funkyfuture/deck-chores/issues/73 to get the picture. It shouldn't be that tricky to update the docs and add this vital piece of information there, please.

M3ssman avatar Jun 19 '23 10:06 M3ssman

thank you for the feedback. do you mean that the passus "can be logged at once" isn't explicit enough?

you're welcome to propose a refinement with a pull request. please bear in mind that users may run deck-chores in different environments and direct log output as they want to.

funkyfuture avatar Jun 19 '23 13:06 funkyfuture

I'll try to do so.

Actually I'm somewhat puzzled, since the text concerning this issue on https://github.com/funkyfuture/deck-chores/blob/main/docs/usage.rst differs from what is published as official doc at https://deck-chores.readthedocs.io/en/stable/usage.html#job-definitions.

Which one shall I refer to?

M3ssman avatar Jun 20 '23 06:06 M3ssman

please refer to the former. i just recently noticed that the docs aren't built in the RTD environment.

funkyfuture avatar Jun 20 '23 17:06 funkyfuture