[Bug] aar-doc command unknown after installation

[moritzrp]

Description

The documentation refers to the use of aar-doc after the installation. But there is no entry point for aar-doc. Instead, aar_doc has to be used.

Reproduction steps

1. Create a fresh virtual environment
2. pip install aar-doc
3. aar-doc [OPTIONS] ROLE_PATH COMMAND [ARGS]...

Current Behavior

Result: aar-doc: command not found

Expected Behavior

aar-doc should be executed.

Additional information

version: aar-doc-1.2.0

[rndmh3ro]

It's aar_doc, with an underscore. I see that the docs are wrong here.. I'll fix them.

[moritzrp]

To keep it consistent with the package name I added an entry point for aar-doc. Could this be a solution instead?

[rndmh3ro]

Good question - I don't know if having both is a good idea from a linux-/shell-/convience standpoint.

[moritzrp]

That's fair. My two cents from user perspective: Having a command that is the same name as the package I just installed is the most convenient and expected behavior.

[rndmh3ro]

Let's do a hyphen then.