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

Clarify documentation on how to build a job runner #16665

Merged
merged 3 commits into from
Sep 10, 2023

Conversation

jdavcs
Copy link
Member

@jdavcs jdavcs commented Sep 7, 2023

This is a very inconsequential edit. Nevertheless, I think it may prevent some confusion that may result when reading the tutorial (see this discussion). Without this edit, it's easy to interpret the description of what the parent class does as a guide to what should be implemented in the new subclass.

UPDATE: In response to reviewer comments, I've provided a clearer explanation of what to override and where. While doing that, I've also made some minor edits to formatting and language which, I hope, improve the tutorial.

Also, fixes #16671.

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@dannon
Copy link
Member

dannon commented Sep 7, 2023

Can you add a bit more detail here? Maybe just another sentence explaining that the parent class handles setup and teardown, and you should only implement the extended logic. As it is I don't think this clarifies it quite enough.

@jdavcs
Copy link
Member Author

jdavcs commented Sep 8, 2023

I've edited the wording. Apparently, all but the __init__ method should be indeed implemented from start to finish, whereas __init__ may be (and usually is) overwritten. I think this new wording makes it more straightforward. (Thanks for suggesting this edit!)

I've also fixed some formatting issues (list nesting, section and subsection titles) that have been bugging me ever since I read this document 5 years ago, but which I never got to addressing.. The language edits are all minor; please feel free to push to my branch if you have better suggestions.

Copy link
Member

@mvdbeek mvdbeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement, thank you!

@mvdbeek mvdbeek merged commit 19faa82 into galaxyproject:dev Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on building a job runner - call to parent constructor
3 participants