docs(elixir): document default polling interval - #122
Closed
nilramoai wants to merge 1 commit into
Closed
Conversation
Summary: - Add the Linear adapter README note for the checked-in default polling cadence. - Point readers to polling.interval_ms in WORKFLOW.md for tuning. Rationale: - The default workflow sets polling.interval_ms to 5000, but the Elixir README did not make that behavior discoverable near the Linear polling docs. Tests: - PATH=/Users/nilram/.local/share/mise/installs/elixir/1.19.5-otp-28/bin:/Users/nilram/.local/share/mise/installs/erlang/28.5/erts-16.4/bin:/Users/nilram/.local/share/mise/installs/erlang/28.5/bin:$PATH HEX_HOME=/Users/nilram/.cache/hex HEX_OFFLINE=1 MIX_HOME=/Users/nilram/.cache/mix make -C elixir all Co-authored-by: Codex <codex@openai.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The default workflow polls Linear every 5 seconds, but the Elixir README did not surface that cadence near the Linear polling docs.
TL;DR
Document the default Linear polling interval and where to configure it.
Summary
elixir/README.md.polling.interval_msinWORKFLOW.mdfor configuration.Alternatives
WORKFLOW.md; rejected because the configured default is already present there.Test Plan
make -C elixir allmake -C elixir fmt-checkawk/rgcheck thatWORKFLOW.mdusesinterval_ms: 5000and README mentions the 5-second default pluspolling.interval_ms.