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

RestoreSessionWithDifferentSources Documentation Errors #19809

Open
JustinPrivitera opened this issue Sep 12, 2024 · 4 comments
Open

RestoreSessionWithDifferentSources Documentation Errors #19809

JustinPrivitera opened this issue Sep 12, 2024 · 4 comments
Labels
docs update to the documentation

Comments

@JustinPrivitera
Copy link
Member

Docs for RestoreSessionWithDifferentSources are wrong.

  • typo under mapping : tuple: "mapping" is misspelled as "maping"
  • more importantly, the example is incorrect. The example uses the RestoreSession example instead.
@JustinPrivitera JustinPrivitera added the docs update to the documentation label Sep 12, 2024
@JustinPrivitera
Copy link
Member Author

Also, the mapping argument seems wrong to me. Look at this example of how the function is actually used:

RestoreSessionWithDifferentSources(tests_path("session","restorewithsources.session"),
0,
silo_data_path("rect3d.silo") )

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
Copy link
Contributor

biagas commented Sep 12, 2024

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
Copy link
Member Author

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs update to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants