[C++-sig] Re: function::argument_error / overloads & docstrings
dave at boost-consulting.com
Thu Nov 6 22:11:11 CET 2003
Nikolay Mladenov <nickm at sitius.com> writes:
> David Abrahams wrote:
>> Help has other means to generate signature information, which doesn't
>> intrude on the docstring. At least, there is a means to tell help
>> about the names of function parameters. You could stick their names
>> in if supplied, and use their C++ types otherwise. I'd look more
>> closely at the attributes used by help to produce its output.
> I see. But the problem is - help only generates one signature per method
> only if the method's implementing function is of type FunctionType. So
> changing the pydoc.py I don't see how can this be done for overloads.
> So why having the option to stick signature in the docstring is bad? It
> is only an option.
I didn't say it was; you were looking for something less intrusive.
> One can do it manually anyway.
> Combining the overloads docstrings shouldn't be a problem as well
> since one can supply a single docstring per name.
Fine with me.
More information about the Cplusplus-sig