visit-dav / visit

VisIt - Visualization and Data Analysis for Mesh-based Scientific Data
https://visit.llnl.gov
BSD 3-Clause "New" or "Revised" License
438 stars 116 forks source link

RestoreSessionWithDifferentSources Documentation Errors #19809

Open JustinPrivitera opened 2 months ago

JustinPrivitera commented 2 months ago

Docs for RestoreSessionWithDifferentSources are wrong.

JustinPrivitera commented 2 months ago

Also, the mapping argument seems wrong to me. Look at this example of how the function is actually used: https://github.com/visit-dav/visit/blob/b847230738bd3b6ef46813b880909044da92551b/src/test/tests/session/restorewithsources.py#L24-L26

Mapping doesn't appear to be a tuple but is instead just a string with the name of the new data file. That should be corrected as well in the documentation.

biagas commented 2 months ago

I believe the tuple is needed if there are multiple source data files used in the session file (eg multiple plots, each from a different database/file.)

JustinPrivitera commented 2 months ago

Ah that makes sense. I couldn't find any examples of that in our repo. I think whoever adds a correct example to the docs ought to have two examples, one for the simple case and one for the more complicated case.

JustinPrivitera commented 2 months ago

Description is also wrong, it is a copy of the RestoreSession Description.