mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Documentation : Add line breaks to make sure Sphinx produce correct doc
This commit is contained in:
parent
211a9ff915
commit
65afd84db5
@ -151,10 +151,10 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
|
||||
{
|
||||
if ( proxyField->hasGetter() )
|
||||
{
|
||||
QString fullComment =
|
||||
QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" )
|
||||
.arg( comment )
|
||||
.arg( dataType );
|
||||
QString fullComment = QString( " \"\"\"%1\n\n Returns:\n "
|
||||
"%2\n \"\"\"" )
|
||||
.arg( comment )
|
||||
.arg( dataType );
|
||||
|
||||
QString fieldCode = QString( " def %1(self):\n%2\n return "
|
||||
"self._call_get_method(\"%3\")\n" )
|
||||
@ -165,7 +165,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
|
||||
}
|
||||
if ( proxyField->hasSetter() )
|
||||
{
|
||||
QString fullComment = QString( " \"\"\"Set %1\n Arguments:\n"
|
||||
QString fullComment = QString( " \"\"\"Set %1\n\n Arguments:\n"
|
||||
" values (%2): data\n \"\"\"" )
|
||||
.arg( comment )
|
||||
.arg( dataType );
|
||||
@ -208,7 +208,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
|
||||
: scriptDataType;
|
||||
|
||||
QString fullComment =
|
||||
QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" )
|
||||
QString( " \"\"\"%1\n\n Returns:\n %2\n \"\"\"" )
|
||||
.arg( comment )
|
||||
.arg( commentDataType );
|
||||
|
||||
@ -271,7 +271,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
|
||||
argumentComments.push_back(
|
||||
QString( "%1 (%2): %3" ).arg( argumentName ).arg( dataType ).arg( field->uiCapability()->uiWhatsThis() ) );
|
||||
}
|
||||
QString fullComment = QString( " \"\"\"\n %1\n Arguments:\n "
|
||||
QString fullComment = QString( " \"\"\"\n %1\n\n Arguments:\n "
|
||||
"%2\n Returns:\n %3\n \"\"\"" )
|
||||
.arg( methodComment )
|
||||
.arg( argumentComments.join( "\n " ) )
|
||||
|
@ -55,6 +55,7 @@ def views(self):
|
||||
@add_method(GridCaseGroup)
|
||||
def view(self, view_id):
|
||||
"""Get a particular view belonging to a case group by providing view id
|
||||
|
||||
Arguments:
|
||||
id(int): view id
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user