[PyQt] Minor glitch in %Docstring example

Phil Thompson phil at riverbankcomputing.com
Wed Jul 17 16:52:34 BST 2019


On 17/07/2019 16:01, Giuseppe Corbelli wrote:
> Hi all
> The document
> https://www.riverbankcomputing.com/static/Docs/sip/directives.html#directive-%Docstring
> 
> 
> has an example that reads:
> public:
>     Klass();
> %Docstring deindented
>     This will be appended to the class's docstring and will not be 
> indented.
> 
>         This will be indented by four spaces.
> %End
> 
> 
> while it should be (note the quotes):
> public:
>     Klass();
> %Docstring "deindented"
>     This will be appended to the class's docstring and will not be 
> indented.
> 
>         This will be indented by four spaces.
> %End
> 
> 
> BTW, what is the correct syntax to get both deindented and appended?
> I tried
> %Docstring "deindented","appended"
> %Docstring "deindented" "appended"
> %Docstring "deindented";"appended"
> 
> with no luck (syntax error).

As it says in the link you posted...

%Docstring(format="deindented", signature="appended")

Phil


More information about the PyQt mailing list