OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Documentation : Add line breaks to make sure Sphinx produce correct doc

Browse Source
This commit is contained in:
Magne Sjaastad 2021-05-04 14:49:05 +02:00
parent 211a9ff915
commit 65afd84db5
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Fwk/AppFwk/cafPdmScripting/cafPdmPythonGenerator.cpp
View File

@ -151,10 +151,10 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
{ {
if ( proxyField->hasGetter() ) if ( proxyField->hasGetter() )
{ {
QString fullComment = QString fullComment = QString( " \"\"\"%1\n\n Returns:\n "
QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" ) "%2\n \"\"\"" )
.arg( comment ) .arg( comment )
.arg( dataType ); .arg( dataType );
QString fieldCode = QString( " def %1(self):\n%2\n return " QString fieldCode = QString( " def %1(self):\n%2\n return "
"self._call_get_method(\"%3\")\n" ) "self._call_get_method(\"%3\")\n" )
@ -165,7 +165,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
} }
if ( proxyField->hasSetter() ) if ( proxyField->hasSetter() )
{ {
QString fullComment = QString( " \"\"\"Set %1\n Arguments:\n" QString fullComment = QString( " \"\"\"Set %1\n\n Arguments:\n"
" values (%2): data\n \"\"\"" ) " values (%2): data\n \"\"\"" )
.arg( comment ) .arg( comment )
.arg( dataType ); .arg( dataType );
@ -208,7 +208,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
: scriptDataType; : scriptDataType;
QString fullComment = QString fullComment =
QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" ) QString( " \"\"\"%1\n\n Returns:\n %2\n \"\"\"" )
.arg( comment ) .arg( comment )
.arg( commentDataType ); .arg( commentDataType );
@ -271,7 +271,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const
argumentComments.push_back( argumentComments.push_back(
QString( "%1 (%2): %3" ).arg( argumentName ).arg( dataType ).arg( field->uiCapability()->uiWhatsThis() ) ); 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 \"\"\"" ) "%2\n Returns:\n %3\n \"\"\"" )
.arg( methodComment ) .arg( methodComment )
.arg( argumentComments.join( "\n " ) ) .arg( argumentComments.join( "\n " ) )

1
GrpcInterface/Python/rips/gridcasegroup.py
View File

@ -55,6 +55,7 @@ def views(self):
@add_method(GridCaseGroup) @add_method(GridCaseGroup)
def view(self, view_id): def view(self, view_id):
"""Get a particular view belonging to a case group by providing view id """Get a particular view belonging to a case group by providing view id
Arguments: Arguments:
id(int): view id id(int): view id