Running poetry --help gives the behaviour of poetry list --help instead of poetry list

[MaddyGuthridge]

• Poetry version: 1.7.1
• Python version: 3.11
• OS version and name: Fedora Linux 38
• pyproject.toml: N/A

• I am on the latest stable Poetry version, installed using a recommended method.
• I have searched the issues of this repo and believe that this is not a duplicate.
• I have consulted the FAQ and blog for any relevant entries or release notes.
• If an exception occurs when executing a command, I executed it again in debug mode (-vvv option) and have included the output below.

Issue

A common design for console applications is to give general help for using the command if the command is run with a --help flag. Some (including Poetry) also give this same output when running the command without arguments. Poetry (seemingly) accomplishes this by aliasing poetry to be equivalent to poetry list.

However, a confusing side effect of this is that running poetry --help is the equivalent to poetry list --help. Given that users who run poetry --help likely want to learn about the available commands within Poetry, this behaviour is likely not the best design, since it creates additional work for users. Every time I forget the correct commands to use when working on a project with Poetry, I run poetry --help, only to need to remind myself of this behaviour and run poetry, which is a little frustrating.

To be clear, this isn't a major issue, but I think that quality-of-life improvements such as this contribute significantly to the developer experience, so some attention to detail wouldn't go astray.

[dimbleby]

Submit a merge request!

[MaddyGuthridge]

I'll definitely give it a go if I have time - it's been added to my (exceedingly long) todo list

[fczuardi]

Do you have some pointer on where to look in the code to know what part deals with the "--help"? Is it on the poetry source code? Or on the cleo source code?

[Secrus]

Do you have some pointer on where to look in the code to know what part deals with the "--help"? Is it on the poetry source code? Or on the cleo source code?

This is in Cleo repo and there is already python-poetry/cleo#249. It's non-trivial to tackle, but will be fixed in Cleo 3.0, which I am working on currently.

[Secrus]

Do you have some pointer on where to look in the code to know what part deals with the "--help"? Is it on the poetry source code? Or on the cleo source code?

This is in Cleo repo and there is already python-poetry/cleo#249. It's non-trivial to tackle, but will be fixed in Cleo 3.0, which I am working on currently.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.