Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Arg: cannot correctly align docstring for Tuple option #7515
Original bug ID: 7515
The Arg.align function allows to correctly align docstrings of the form
-foo FOO My docstring for foo
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.