Skip to content
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

Add note about click in Addon dev/CLI interface #297

Open
2 tasks done
MustafaJafar opened this issue Oct 18, 2024 · 0 comments
Open
2 tasks done

Add note about click in Addon dev/CLI interface #297

MustafaJafar opened this issue Oct 18, 2024 · 0 comments
Assignees
Labels
Dev Docs type: enhancement New feature or request

Comments

@MustafaJafar
Copy link
Contributor

MustafaJafar commented Oct 18, 2024

Is there an existing issue for this?

  • I have searched the existing issues.

Please describe the feature you have in mind and explain what the current shortcomings are?

Reported on discord
On your example :
In /server/init.py one of the args is "show-selected-path"
In /client/my_addon/init.py the func is called "show_selected_path"

which is the behavior or click as mentioned in pallets/click#1123

From the Click's github discussion :
You can still use underscores by specifying the command names explicitly. It's just that the default is now to replace with dashses, to look more consistent with other CLI tools, whereas before you would have had to specify those explicitly.

Therefore, we should mention that in cli interface docs.

How would you imagine the implementation of the feature?

.

Are there any labels you wish to add?

  • I have added the relevant labels to the enhancement request.

Describe alternatives you've considered:

No response

Additional context:

No response

@MustafaJafar MustafaJafar added type: enhancement New feature or request Dev Docs labels Oct 18, 2024
@MustafaJafar MustafaJafar self-assigned this Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev Docs type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant