jupyterhub / jupyterhub/batchspawner

README should not steer new users to overriding submit script template

Open
#232 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
207
Forks
136
PR merge metrics
No merged PRs in 30d

Description

The current example configuration code in the README steers new users in an unhelpful direction:

https://github.com/jupyterhub/batchspawner/blob/f4659678061dacf5837fb15ce340230dca18f3ca/README.md?plain=1#L84-L93

If copied, this sample overrides the template script provided with the class, losing features that are implemented with template logic. The sample code should be replaced with one that uses the provided configuration variables (`req_*` etc) in accordance with recommended practice.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.