From c994c556afbc195f3cb991f410bb85edf6b97017 Mon Sep 17 00:00:00 2001 From: "Mark C. Miller" Date: Fri, 4 Oct 2024 13:31:51 -0700 Subject: [PATCH] document action --- .github/workflows/check_methoddoc_gen.yaml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check_methoddoc_gen.yaml b/.github/workflows/check_methoddoc_gen.yaml index a071d74508..9c678573c9 100644 --- a/.github/workflows/check_methoddoc_gen.yaml +++ b/.github/workflows/check_methoddoc_gen.yaml @@ -73,8 +73,22 @@ jobs: 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 +# So, developers should just edit functions.rst and then follow the documentation +# https://visit-sphinx-github-user-manual.readthedocs.io/en/develop/dev_manual/UpdatingPythonDocStrings.html +# to regenerate MethodDoc.C. +# +# The logic in this action only gets triggered if any of the files listed as `path` members of +# `the pull_request` action are involved. Next, if any those files are involved, it then examines +# the list of ALL changed files in the PR to check if functions.rst is invovled and if MethodDoc.C +# is involved. +# +# If either one or the other is involved but not both, it fails with an error message. +# +# If both are involved, it then tries to perform the MethodDoc.C generation and confirm the +# result is what is being committed. If not, it fails also. +#