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

Modification to EnsContext() documentation #301

Open
kecolburn opened this issue Sep 8, 2023 · 1 comment
Open

Modification to EnsContext() documentation #301

kecolburn opened this issue Sep 8, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kecolburn
Copy link
Collaborator

Description of the modifications

EnsContext() documentation needs further information of the ._capture_context() and ._restore_context()
In addition, having EnSight use the same documentation as well.

Useful links and references

No response

@kecolburn kecolburn added the documentation Improvements or additions to documentation label Sep 8, 2023
@mariostieriansys
Copy link
Collaborator

@kecolburn the methods _capture_context() and _restore_context() are private, and they are not supposed to be called directly.
In session there are wrapper calls, capture_context() and restore_context() that can be used, and that will call these for you.
Also, they will call the _ methods directly in EnSight, rather than through PyEnSight.

Is there any reason why you would like to use directly the _capture_context() and _restore_context() feature?

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

No branches or pull requests

2 participants