fix(docs): correct {:cont} docstring — processing continues, not halts#557
Open
aadhar-build wants to merge 1 commit into
Open
fix(docs): correct {:cont} docstring — processing continues, not halts#557aadhar-build wants to merge 1 commit into
aadhar-build wants to merge 1 commit into
Conversation
The docstring for JsonProcessor.run/2 incorrectly stated that returning
{:cont, %Message{}} means "no additional processors are run". The actual
implementation returns {:cont, ...} which continues processing through
subsequent processors — {:halt, ...} is what stops further processing.
Aligns the documented behaviour with the code and the :cont/:halt semantics.
Fixes brainlid#215
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.
Summary
The
JsonProcessor.run/2docstring incorrectly described the{:cont, %Message{}}return value as stopping further processing:This is the opposite of what
:contdoes. Looking at the implementation (line 131),{:cont, ...}continues processing through subsequent processors — it's{:halt, ...}that stops further processors, as the very next bullet in the docstring correctly states.Change
One line: corrected "no additional processors are run" → "processing continues with subsequent processors"
No code changes. Documentation only.
Fixes #215