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

[ci skip] | Docs | Clarify worker_timeout minimum value #3226

Merged
merged 2 commits into from
Sep 17, 2023

Conversation

joshuay03
Copy link
Contributor

@joshuay03 joshuay03 commented Sep 17, 2023

Description

When writing a test for #3225 I set the worker_timeout to be 2s to avoid a test timeout. To do that, I needed to reduce the worker_check_interval to 1s to comply with this validation.

However, the docs imply that the minimum worker_timeout can only be 6s, since it is greater than the default worker_check_interval of 5s.

I've updated the docs to clarify that the minimum simply needs to comply with this validation, and removed any mention of a specific value as it can be infered from either the default worker_check_interval in the docs or the user configured value.

Your checklist for this pull request

  • I have reviewed the guidelines for contributing to this repository.
  • I have added (or updated) appropriate tests if this PR fixes a bug or adds a feature.
  • My pull request is 100 lines added/removed or less so that it can be easily reviewed.
  • If this PR doesn't need tests (docs change), I added [ci skip] to the title of the PR.
  • If this closes any issues, I have added "Closes #issue" to the PR description or my commit messages.
  • I have updated the documentation accordingly.
  • All new and existing tests passed, including Rubocop.

@joshuay03 joshuay03 force-pushed the clarify-worker-timeout-min-value branch from d88bfa0 to fd88328 Compare September 17, 2023 12:33
@joshuay03 joshuay03 changed the title Docs | Clarify worker_timeout minimum value [ci skip] | Docs | Clarify worker_timeout minimum value Sep 17, 2023
@joshuay03 joshuay03 force-pushed the clarify-worker-timeout-min-value branch from fd88328 to f1de80c Compare September 17, 2023 12:35
@nateberkopec
Copy link
Member

Slight change to your wording but 👍

@nateberkopec nateberkopec merged commit 68d9b97 into puma:master Sep 17, 2023
5 checks passed
joshuay03 added a commit to joshuay03/puma that referenced this pull request Sep 26, 2023
* Docs | Clarify `worker_timeout` minimum value

* Update dsl.rb

---------

Co-authored-by: Nate Berkopec <nate.berkopec@gmail.com>
@joshuay03 joshuay03 deleted the clarify-worker-timeout-min-value branch March 4, 2024 04:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants