Skip to content

Commit

Permalink
fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
markcmiller86 committed Oct 19, 2024
1 parent 46219e6 commit 85aac3b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 25 deletions.
27 changes: 15 additions & 12 deletions src/doc/python_scripting/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,15 @@ variableName : string

inheritSIL : integer
An integer flag indicating whether the plot should inherit the
active plot's SIL restriction.
active plot's SIL restriction. A zero value indicates that the SIL
should **not** be inherited. A non-zero value indicates that the SIL
should be inherited.

applyOperators : integer
An integer flag indicating whether the operators from the active
plot should be applied to the new plot.
plot should be applied to the new plot. A zero value indicates that
the operators should **not** be applied. A non-zero value indicates that
the operators should be applied.

return type : CLI_return_t
The AddPlot function returns an integer value of 1 for success and 0 for
Expand Down Expand Up @@ -4036,7 +4040,7 @@ return type : tuple of strings
DrawPlots()
mats = GetMaterials()
for m in mats[:-1]:
TurnMaterialOff(m)
TurnMaterialsOff(m)


GetMeshManagementAttributes
Expand Down Expand Up @@ -4341,14 +4345,16 @@ return type : dictionary
For example, a Curve plot will return the xy pairs that comprise the curve.
The tuple is arranged <x1, y1, x2, y2, ..., xn, yn>.

For time queries that create multiple curves, e.g. Time Pick with multiple variables, the dictionary contains a 'Curves' object, and each curve is referenced by it's associated variable name.
This was introduced in VisIt 3.4.1.
For time queries that create multiple curves, e.g. Time Pick with multiple
variables, the dictionary contains a 'Curves' object, and each curve is
referenced by it's associated variable name. This was introduced in
VisIt 3.4.1.


**Single Curve Example:**
**Example:**

::

# Single curve example
#% visit -cli
OpenDatabase("/usr/gapps/visit/data/rect2d.silo")
AddPlot("Pseudocolor", "d")
Expand All @@ -4359,10 +4365,7 @@ return type : dictionary
lineout = info["Curve"]
print("The first lineout point is: [%g, %g] " % lineout[0], lineout[1])

**Multiple Curve Example:**

::

# Multiple curve example
#% visit -cli
OpenDatabase("/usr/gapps/visit/data/wave.visit")
AddPlot("Pseudocolor", "pressure")
Expand Down Expand Up @@ -10460,7 +10463,7 @@ format_string : string
**Description:**

The SetQueryFloatFormat method sets a :ref:`printf-style <FormattingNumbers>` format string that
is used by VisIt's queries to produce textual output.
is used by VisIt's querys to produce textual output.


**Example:**
Expand Down
26 changes: 13 additions & 13 deletions src/visitpy/common/MethodDoc.C
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,14 @@ const char *visit_AddPlot_doc =
" A valid variable name for the open database.\n"
"inheritSIL : integer\n"
" An integer flag indicating whether the plot should inherit the\n"
" active plot's SIL restriction.\n"
" active plot's SIL restriction. A zero value indicates that the SIL\n"
" should **not** be inherited. A non-zero value indicates that the SIL\n"
" should be inherited.\n"
"applyOperators : integer\n"
" An integer flag indicating whether the operators from the active\n"
" plot should be applied to the new plot.\n"
" plot should be applied to the new plot. A zero value indicates that\n"
" the operators should **not** be applied. A non-zero value indicates that\n"
" the operators should be applied.\n"
"\n"
"\n"
"Returns:\n"
Expand Down Expand Up @@ -3652,12 +3656,9 @@ const char *visit_GetLastMessage_doc =
"\n"
"GetLastMessage() -> (message, severity)\n"
"GetLastMessage(int-clr) -> (message, severity)\n"
"\n"
"\n"
"Returns:\n"
"\n"
" GetLastMessage returns a tuple containing 2 strings, the last message and its severity.\n"
" If int-clr is present and is non-zero, once the message is retrieved it is also cleared.\n"
"GetLastMessage returns a tuple containing 2 strings, the last message and its severity.\n"
"If int-clr is present and is non-zero, once the message is retrieved it is also cleared.\n"
"\n"
"\n"
"Description:\n"
Expand Down Expand Up @@ -3892,7 +3893,7 @@ const char *visit_GetMaterials_doc =
"DrawPlots()\n"
"mats = GetMaterials()\n"
"for m in mats[:-1]:\n"
" TurnMaterialOff(m)\n"
" TurnMaterialsOff(m)\n"
;
const char *visit_GetMeshManagementAttributes_doc =
"GetMeshManagementAttributes\n"
Expand Down Expand Up @@ -4192,8 +4193,9 @@ const char *visit_GetPlotInformation_doc =
"VisIt 3.4.1.\n"
"\n"
"\n"
"Single Curve Example:\n"
"Example:\n"
"\n"
"# Single curve example\n"
"#% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/rect2d.silo\")\n"
"AddPlot(\"Pseudocolor\", \"d\")\n"
Expand All @@ -4203,9 +4205,7 @@ const char *visit_GetPlotInformation_doc =
"info = GetPlotInformation()\n"
"lineout = info[\"Curve\"]\n"
"print(\"The first lineout point is: [%g, %g] \" % lineout[0], lineout[1])\n"
"\n"
"Multiple Curve Example:\n"
"\n"
"# Multiple curve example\n"
"#% visit -cli\n"
"OpenDatabase(\"/usr/gapps/visit/data/wave.visit\")\n"
"AddPlot(\"Pseudocolor\", \"pressure\")\n"
Expand Down Expand Up @@ -10093,7 +10093,7 @@ const char *visit_SetQueryFloatFormat_doc =
"Description:\n"
"\n"
"The SetQueryFloatFormat method sets a printf-style format string that\n"
"is used by VisIt's queries to produce textual output.\n"
"is used by VisIt's querys to produce textual output.\n"
"\n"
"\n"
"Example:\n"
Expand Down

0 comments on commit 85aac3b

Please sign in to comment.