Skip to content

Fix edoc and add edoc CI test - #58

Merged
mworrell merged 2 commits into
masterfrom
edoc-test
May 18, 2026
Merged

Fix edoc and add edoc CI test#58
mworrell merged 2 commits into
masterfrom
edoc-test

Conversation

@mworrell

Copy link
Copy Markdown
Member

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:

  • Added an Edoc step to the .github/workflows/test.yml workflow to generate and check Erlang documentation during CI runs.

Documentation corrections:

  • Fixed minor inconsistencies in the documentation comments in src/cowmachine_util.erl by standardizing the use of single quotes for the too_many_qs_names atom. [1] [2]

Copilot AI review requested due to automatic review settings May 18, 2026 09:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 edoc as part of the CI workflow to ensure EDoc generation stays healthy.
  • Update EDoc comments in cowmachine_util.erl related to the too_many_qs_names throw 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 atom too_many_qs_names. Update the doc to use too_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.

Comment thread src/cowmachine_util.erl
Comment thread src/cowmachine_util.erl Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@mworrell
mworrell merged commit ba75d58 into master May 18, 2026
3 checks passed
@mworrell
mworrell deleted the edoc-test branch May 18, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants