Skip to content

fix: improve coder_script related docs #191

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

Merged
merged 2 commits into from
Feb 9, 2024

Conversation

mafredri
Copy link
Member

@mafredri mafredri commented Feb 9, 2024

Comment on lines 29 to 31
if !runOnStart && startBlocksLogin {
return diag.Errorf("start_blocks_login can only be set if run_on_start is true")
}
Copy link
Member

Choose a reason for hiding this comment

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

Does this extra check risk breaking any existing usage?

Copy link
Member Author

Choose a reason for hiding this comment

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

Possibly, but it also alerts users to a misconfiguration that will cause unexpected results.

Copy link
Member

Choose a reason for hiding this comment

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

Might be worth calling this out as a potentially breaking change then. LGTM otherwise 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

I broke it out to a separate PR, this was a good callout tbh: #192

@mafredri mafredri force-pushed the mafredri/fix-docs-and-validation branch from 1f7d0a3 to 62c590d Compare February 9, 2024 17:31
@johnstcn johnstcn changed the title fix: improve coder_script related docs and validation fix: improve coder_script related docs Feb 9, 2024
@mafredri mafredri merged commit 908ab27 into main Feb 9, 2024
@mafredri mafredri deleted the mafredri/fix-docs-and-validation branch February 9, 2024 17:37
@github-actions github-actions bot locked and limited conversation to collaborators Feb 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants