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

FEATURE: add templates for examples #4

Closed
1 of 2 tasks
SMoraisAnsys opened this issue Feb 19, 2024 · 1 comment
Closed
1 of 2 tasks

FEATURE: add templates for examples #4

SMoraisAnsys opened this issue Feb 19, 2024 · 1 comment
Assignees

Comments

@SMoraisAnsys
Copy link
Collaborator

SMoraisAnsys commented Feb 19, 2024

While working on making examples working with the new documentation workflow, I noticed that our examples do not follow the same template at all. I think it could be great to have an example template from which every example should "inherit".

Here is a list of stuff/sections that should be contained:

  • imports
  • define extra class / function used in the example
  • setup environment : tempfile + download (if needed)
  • setup the app
  • make all the processing
  • cleanup : save project and remove tempfile

Since we will have multiple type of examples it would be nice to start with:

Note: this templates could also be used in the CI to roughly check that a provided new example matches some expected template !

@SMoraisAnsys SMoraisAnsys changed the title Template example FEATURE: add templates for examples Feb 20, 2024
@Devin-Crawford Devin-Crawford self-assigned this Jun 12, 2024
@Samuelopez-ansys
Copy link
Member

#154

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

No branches or pull requests

3 participants