Skip to content

Improve Documentation about Collections /tasks directories #1029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hadmut opened this issue Apr 7, 2025 · 0 comments
Open

Improve Documentation about Collections /tasks directories #1029

hadmut opened this issue Apr 7, 2025 · 0 comments

Comments

@hadmut
Copy link

hadmut commented Apr 7, 2025

Hi,
I have a long background from traditional make and Ruby's rake, but need to migrate some tasks to a system which has python3 only, and thus I'm currently learning invoke.

After I read somewhere that invoke can read the tasks not only from a single tasks.py, but a tasks directory with a hierarchy of files, but invoke's own documentation is not really informative about that. It was quite difficult to find that these are called "Collections", and that invoke prefers a tasks directory over a tasks.py due to python's loading mechanism.

However, I created a tasks with a tasks/init.py and a tasks/example.py, but the task in example.py is not found by invoke -l and I don't see why.

Sorry to say, but your documentation does not really help and is rather incomprehensible. In other words: If one has the knowledge required to understand your documentation, he doesn't need it anymore.

A documentation should consist of a systematical order of steps, each explaining how to use the tool, and in fact, there is a "getting started", but this stops after the very basics.

There is a documents section 3.1.6 Collection-based configuration , but it doesn't even bother to define the term or tell what the term "Collection" means here, or what it looks like. One can read it and read it and read it and still doesn't know what it is or how to build one.

regards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant