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

JOB_ID_SEPARATOR should be documented #81

Open
bdice opened this issue Mar 16, 2020 · 2 comments
Open

JOB_ID_SEPARATOR should be documented #81

bdice opened this issue Mar 16, 2020 · 2 comments
Labels
Contribution Welcome New developers are welcomed to contribute to this issue or pull request

Comments

@bdice
Copy link
Member

bdice commented Mar 16, 2020

Issue Description

This pull request adds a feature to Environment classes: by defining an attribute JOB_ID_SEPARATOR, submitted jobs will use that separator string instead of a slash '/' in the submitted job names. This is needed for clusters that do not support slash as a character in the job name, as documented in this issue.

Proposed change (optional)

Add a short note about JOB_ID_SEPARATOR into environments.rst: https://github.com/glotzerlab/signac-docs/blob/master/docs/source/environments.rst

@csadorf
Copy link
Contributor

csadorf commented Mar 16, 2020

Why is this not a class attribute with a default value? Then one could document it with a docstring?

@bdice
Copy link
Member Author

bdice commented Mar 16, 2020

Why is this not a class attribute with a default value? Then one could document it with a docstring?

Sounds like a good idea to me. I like that option better than my original proposal. I’ll rename the issue title to be solution-agnostic.

@bdice bdice changed the title JOB_ID_SEPARATOR should be documented in environments.rst JOB_ID_SEPARATOR should be documented Mar 16, 2020
@kidrahahjo kidrahahjo added the Contribution Welcome New developers are welcomed to contribute to this issue or pull request label Nov 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution Welcome New developers are welcomed to contribute to this issue or pull request
Projects
None yet
Development

No branches or pull requests

3 participants