You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
MethodDoc.[Ch] are generated from .rst files. This allows us to have easily human readable and editable content documenting the CLI but still have that content appear in help(foo) from within the VisIt CLI python interpreter.
Having the generated files be part of our repo creates confusion especially for newbie or occasional developers. And, there is really no reason we need to keep the generated files in the repo.
Lets remove them from the repo and generate them at CMake time. This would eliminate any confusion over what to edit and eliminate the need for any CI (see proposed #19879) too.
The text was updated successfully, but these errors were encountered:
Besides which, there are some that cannot be auto-regenerated due to specialized logic not easily codified in our xml generation scheme.
Right but those cases are tagged as such and they represent a substantial minority of the cases, right? If so, I kinda sorta get why it might make sense to get rid of the majority of them. But, I think thats a different issue ticket if someone wants to file it...hint hint...for a special topics discussion...
Is your feature request related to a problem?
MethodDoc.[Ch]
are generated from.rst
files. This allows us to have easily human readable and editable content documenting the CLI but still have that content appear inhelp(foo)
from within the VisIt CLI python interpreter.Having the generated files be part of our repo creates confusion especially for newbie or occasional developers. And, there is really no reason we need to keep the generated files in the repo.
Lets remove them from the repo and generate them at CMake time. This would eliminate any confusion over what to edit and eliminate the need for any CI (see proposed #19879) too.
The text was updated successfully, but these errors were encountered: