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

Arg: cannot correctly align docstring for Tuple option #7515

Closed
vicuna opened this issue Apr 10, 2017 · 4 comments

Comments

Projects
None yet
1 participant
@vicuna
Copy link

commented Apr 10, 2017

Original bug ID: 7515
Reporter: @nojb
Status: closed (set by @alainfrisch on 2017-06-30T08:31:24Z)
Resolution: fixed
Priority: normal
Severity: minor
Fixed in version: 4.06.0 +dev/beta1/beta2/rc1
Category: standard library

Bug description

The Arg.align function allows to correctly align docstrings of the form

-foo FOO My docstring for foo
-bar BAR My docstring for bar

by using the docstring "FOO My docstring for foo" in the first case and "BAR My docstring for bar" in the second case.

Unfortunately this does not allow to document Tuple arguments which have more than argument component, e.g.

-tuple FOO BAR My docstring for foo

In other words, it would be nice to be able to somehow include spaces in the "first word" of the docstring.

I am not sure what a good solution would be that would not break backwards compatibilty.

Maybe we could declare a not-very-common character to be rendered as a space when found in the "first word" of the docstring.

@vicuna

This comment has been minimized.

Copy link
Author

commented Apr 10, 2017

Comment author: @nojb

Mantis stripped the spaces from my description; several spaces are supposed to be present before "My docstring..." in each case.

@vicuna

This comment has been minimized.

Copy link
Author

commented Apr 10, 2017

Comment author: @nojb

Possible solution at #1147

@vicuna

This comment has been minimized.

Copy link
Author

commented Jun 13, 2017

Comment author: @nojb

This can be closed, as the PR has been merged.

@vicuna

This comment has been minimized.

Copy link
Author

commented Jun 28, 2017

Comment author: @damiendoligez

Fixed in trunk by #1147. Thanks @nojebar !

@vicuna vicuna closed this Jun 30, 2017

@vicuna vicuna added stdlib bug labels Mar 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.