Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an EDoc build step to the GitHub Actions CI workflow and adjusts EDoc comments in cowmachine_util so documentation generation is validated in CI.
Changes:
- Run
make edocas part of the CI workflow to ensure EDoc generation stays healthy. - Update EDoc comments in
cowmachine_util.erlrelated to thetoo_many_qs_namesthrow condition.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/cowmachine_util.erl |
Updates EDoc text around parse_qs/1,2 error behavior. |
.github/workflows/test.yml |
Adds an EDoc step (make edoc) to CI. |
Comments suppressed due to low confidence (1)
src/cowmachine_util.erl:381
- Same as above: the inline-code markup
too_many_qs_names'contains a trailing quote and doesn’t match the thrown atomtoo_many_qs_names. Update the doc to usetoo_many_qs_names(or'too_many_qs_names'with both quotes) to avoid confusing/incorrect documentation.
%% maximum number of parsed name/value pairs. If more that the given
%% amount is parsed then `too_many_qs_names' is thrown. If a value is
%% missing then the value is assumed to be the empty string.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
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.
This pull request introduces a minor improvement to the CI workflow and makes small documentation corrections in the codebase. The most notable change is the addition of an Edoc (Erlang documentation) generation step to the GitHub Actions workflow, ensuring that documentation is built and checked as part of the CI process.
Continuous Integration improvements:
Edocstep to the.github/workflows/test.ymlworkflow to generate and check Erlang documentation during CI runs.Documentation corrections:
src/cowmachine_util.erlby standardizing the use of single quotes for thetoo_many_qs_namesatom. [1] [2]