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

Update config.rst #489

Merged
merged 9 commits into from
Sep 13, 2024
Merged

Update config.rst #489

merged 9 commits into from
Sep 13, 2024

Conversation

anton-seaice
Copy link
Collaborator

Following on from #487 (comment)

Hopefully this clarifies how userscripts work (it will for me anyway :-) )

@coveralls
Copy link

coveralls commented Aug 20, 2024

Coverage Status

coverage: 55.974% (+3.4%) from 52.565%
when pulling b2fdfb1 on anton-seaice-patch-1
into 39b9ba4 on master.

@anton-seaice anton-seaice marked this pull request as ready for review August 20, 2024 22:52
aidanheerdegen
aidanheerdegen previously approved these changes Aug 21, 2024
Copy link
Collaborator

@aidanheerdegen aidanheerdegen left a comment

Choose a reason for hiding this comment

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

It's a good change I think. Thanks @anton-seaice

I think we should put something in there about error handling to make it clear to users that a script or command that returns an error state can (and probably should) stop the model from running.

Now this doesn't have to happen in this PR, but it might make sense to do so.

docs/source/config.rst Outdated Show resolved Hide resolved
docs/source/config.rst Outdated Show resolved Hide resolved
Co-authored-by: Aidan Heerdegen <[email protected]>
jo-basevi
jo-basevi previously approved these changes Aug 22, 2024
Copy link
Collaborator

@jo-basevi jo-basevi left a comment

Choose a reason for hiding this comment

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

Thanks for fixing up the documentation!

docs/source/config.rst Outdated Show resolved Hide resolved
@anton-seaice
Copy link
Collaborator Author

Sorry I did the old trick of writing comments and then not clicking submit! ... See #489 (comment)

@anton-seaice
Copy link
Collaborator Author

I think this is ready to go now :)

Copy link
Collaborator

@jo-basevi jo-basevi left a comment

Choose a reason for hiding this comment

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

Had a read through, and it looks good to me!

@anton-seaice
Copy link
Collaborator Author

Thanks @jo-basevi !

@anton-seaice anton-seaice merged commit c07eeaf into master Sep 13, 2024
8 checks passed
@anton-seaice anton-seaice deleted the anton-seaice-patch-1 branch September 13, 2024 01:14
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.

4 participants