LoadState documentation is missing
I have a user that is trying to LoadState in Python, and got completely confused. I took a look, and got confused also. Using Python, LoadState documentation is missing and/or out of date. Here is what I mean:
-
Load State added features to allow loading to occur from either directories in the state file, or a specific directory, or specific files. This can now be done in Python. Whoot! This is documented here, at the bottom. https://blog.kitware.com/new-options-when-loading-paraview-state-files/. This is the verbose version, without any detail or explanation. If possible, this blog entry should be edited to say details are in the Users Guide. -
The User Guide has a whole chapter dedicated to Loading State. But, none of the complex commands listed above are explained, or even mentioned. Please document these options, with examples, and explain when they are needed and not needed. This is chapter 8.4. The simpler cases do work correctly - why would anyone ever want the complex versions? -
The Trace Recorder always dumps the complex version. I would rather this command was simpler for the simpler cases, but don't think it is a big deal. Would it be simple to modify the code to write the simple case? -
In Python, I tried help(LoadState). This came up with the following: 'LoadState(filename, connection=None, **extraArgs)'. Not what I am looking for... Shouldn't this filter/command be documented, so users can see a bit of usage? Or, did I do this wrong?
@utkarsh.ayachit @cory-quammen @shawn.waldon
Thanks guys!
Edited by Utkarsh Ayachit