cliff.sphinxext required arguments have hyphen formatting problem
Bug #1712612 reported by
Michael Johnson
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| cliff |
New
|
Undecided
|
Unassigned | ||
Bug Description
When using the cliff.sphinxext extension to document our OSC commands we noticed that if a required argument (non-required arguments seem to be fine) has a hypen in it, the example text generated has strange formating with extra new lines.
See the attached example images (the patch with the change to using cliff.sphinxext is not up yet).
Revision history for this message
| Michael Johnson (johnsom) wrote | #1 |
Revision history for this message
| Michael Johnson (johnsom) wrote | #2 |
Revision history for this message
| Michael Johnson (johnsom) wrote | #3 |
To post a comment you must log in.
Live example from the python-ironicclient CLI docs:
https:/