From 6a1a28facce0eb0f947c90e8e2984dfce7a4a37b Mon Sep 17 00:00:00 2001 From: "Mark C. Miller" Date: Fri, 4 Oct 2024 13:26:24 -0700 Subject: [PATCH] sync the files --- .github/workflows/check_methoddoc_gen.yaml | 6 ++++++ src/doc/python_scripting/functions.rst | 3 +-- src/visitpy/common/MethodDoc.C | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check_methoddoc_gen.yaml b/.github/workflows/check_methoddoc_gen.yaml index d28e5d6172..a071d74508 100644 --- a/.github/workflows/check_methoddoc_gen.yaml +++ b/.github/workflows/check_methoddoc_gen.yaml @@ -72,3 +72,9 @@ jobs: echo " Please follow https://visit-sphinx-github-user-manual.readthedocs.io/en/develop/dev_manual/UpdatingPythonDocStrings.html" exit 1 fi + +# Documentation of this action +# +# This action is designed to catch cases where developers make inconsistent changes to +# functions.rst and MethodDoc.C. MethodDoc.C is ordinarily *generated* from functions.rst +# So, developers should just edit functions diff --git a/src/doc/python_scripting/functions.rst b/src/doc/python_scripting/functions.rst index c612498506..0b291a218d 100644 --- a/src/doc/python_scripting/functions.rst +++ b/src/doc/python_scripting/functions.rst @@ -1,6 +1,5 @@ - Functions ========= @@ -10464,7 +10463,7 @@ format_string : string **Description:** The SetQueryFloatFormat method sets a :ref:`printf-style ` format string that - is used by VisIt's querys to produce textual output. + is used by VisIt's queries to produce textual output. **Example:** diff --git a/src/visitpy/common/MethodDoc.C b/src/visitpy/common/MethodDoc.C index 0c34bb9981..672a8ec07f 100644 --- a/src/visitpy/common/MethodDoc.C +++ b/src/visitpy/common/MethodDoc.C @@ -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 querys to produce textual output.\n" +"is used by VisIt's queries to produce textual output.\n" "\n" "\n" "Example:\n"