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

[minor] update docstring for TemplateJob #1452

Merged
merged 1 commit into from
May 29, 2024
Merged

[minor] update docstring for TemplateJob #1452

merged 1 commit into from
May 29, 2024

Conversation

samwaseda
Copy link
Member

There was a huge confusion yesterday as it was not clear how to use a custom job defined in TemplateJob so I updated the doc string.

@jan-janssen
Copy link
Member

I like the update to the docstring, I am just a bit surprised that people still use the TemplateJob class directly. I thought we replaced that by wrap_python_function() and create_job_class() https://pyiron-base.readthedocs.io/en/latest/example.html

@samwaseda
Copy link
Member Author

One case where people want to use TemplateJob is when they want to use a variable for both input and output. In that case it makes more sense to define it in __init__ and use it in write_input and collect_output.

But one way or other, as long as the class is there we should make it user-friendly.

@samwaseda samwaseda merged commit 48f6dc6 into main May 29, 2024
25 checks passed
@samwaseda samwaseda deleted the update_doc branch May 29, 2024 07:08
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

Successfully merging this pull request may close these issues.

None yet

2 participants