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

Parameter arg documentation pulled into help string #4396

Open
7 tasks done
Qalthos opened this issue Feb 17, 2025 · 0 comments
Open
7 tasks done

Parameter arg documentation pulled into help string #4396

Qalthos opened this issue Feb 17, 2025 · 0 comments
Labels

Comments

@Qalthos
Copy link
Collaborator

Qalthos commented Feb 17, 2025

Prerequisites

  • This was not already reported in the past (duplicate check)
  • It does reproduce it with code from main branch (latest unreleased version)
  • I include a minimal example for reproducing the bug
  • The bug is not trivial, as for those a direct pull-request is preferred
  • Running pip check does not report any conflicts
  • I was able to reproduce the issue on a different machine
  • The issue is not specific to any driver other than 'default' one

Environment

25.2.0

What happened

Since adding argument docs to molecule commands to appease pydoclint, these have been pulled unformatted into the click help output. This is expected, as it lives in the docstring, but unwanted, as it is unhelpful to the user

Reproducing example

molecule test -h:

Usage: molecule test [OPTIONS] [ANSIBLE_ARGS]...

  Test (dependency, cleanup, destroy, syntax, create, prepare, converge, idempotence, side_effect, verify, cleanup,
  destroy).

  Args:     ctx: Click context object holding commandline arguments.     scenario_name: Name of the scenario to
  target.     exclude: Name of the scenarios to avoid targeting.     driver_name: Name of the driver to use.
  __all: Whether molecule should target scenario_name or all scenarios.     destroy: The destroy strategy to use.
  parallel: Whether the scenario(s) should be run in parallel mode.     ansible_args: Arguments to forward to
  Ansible.     platform_name: Name of the platform to use.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

2 participants