Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace MethodDoc.[Ch] with generation at CMake time #19881

Open
markcmiller86 opened this issue Oct 6, 2024 · 4 comments
Open

Replace MethodDoc.[Ch] with generation at CMake time #19881

markcmiller86 opened this issue Oct 6, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@markcmiller86
Copy link
Member

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 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.

@markcmiller86 markcmiller86 added the enhancement New feature or request label Oct 6, 2024
@JustinPrivitera
Copy link
Member

Can we get rid of .C and .h files associated with .xml and .code files???

@markcmiller86
Copy link
Member Author

Can we get rid of .C and .h files associated with .xml and .code files???

Seems a tad beyond the scope of this issue.

@biagas
Copy link
Contributor

biagas commented Oct 7, 2024

Can we get rid of .C and .h files associated with .xml and .code files???

Seems a tad beyond the scope of this issue.

Besides which, there are some that cannot be auto-regenerated due to specialized logic not easily codified in our xml generation scheme.

@markcmiller86
Copy link
Member Author

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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants