Skip to content

Conversation

m11dedhia
Copy link

  • switched from single-line comments to multi-line comments

Signed-off-by: Megh Dedhia [email protected]

What I did

Modified macro-gen_click_options inside sonic-utilities-data/templates/sonic-cli-gen/config.py.j2 to render all strings as multi-line comment for help option under click.option

How I did it

How to verify it

sonic-cli-gen generate config sonic-buffer-pool
config buffer-pool

Previous command output (if the output of a command-line utility has changed)

failed to import plugin config.plugins.auto.sonic-buffer-pool_yang: unterminated string literal (detected at line 287) (sonic-buffer-pool_yang.py, line 287)

New command output (if the output of a command-line utility has changed)

Usage: config buffer-pool [OPTIONS] COMMAND [ARGS]...

Options:
  -h, -?, --help   Show this message and exit

Commands:
  add          Add object in BUFFER_POOL.
  delete      Delete object in BUFFER_POOL.
  update    Add object in BUFFER_POOL.

Fixes sonic-net/sonic-buildimage#24006

…omments

* switched from single-line comments to multi-line comments

Signed-off-by: Megh Dedhia [email protected]
Copy link

linux-foundation-easycla bot commented Sep 16, 2025

CLA Signed

  • ✅login: m11dedhia / name: Megh Dedhia / (d5fb7e1)

The committers listed above are authorized under a signed CLA.

@mssonicbld
Copy link
Collaborator

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Contributor

@anders-nexthop anders-nexthop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

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

Successfully merging this pull request may close these issues.

Bug: Multi-line help strings throw an error in click.options
3 participants