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

compiler: Add warn_missing_doc_functions et all and enable in all docs #8123

Merged
merged 5 commits into from
Feb 20, 2024

Conversation

garazdawi
Copy link
Contributor

This PR adds support for enabling and disabling warnings on missing functions, types and callbacks individually.

Also enable such warnings in Erlang/OTP for all applications.

@garazdawi garazdawi added the team:VM Assigned to OTP team VM label Feb 15, 2024
@garazdawi garazdawi self-assigned this Feb 15, 2024
Copy link
Contributor

github-actions bot commented Feb 15, 2024

CT Test Results

    20 files     782 suites   5h 25m 9s ⏱️
 8 836 tests  8 643 ✅   192 💤 1 ❌
20 589 runs  19 436 ✅ 1 153 💤 0 ❌

For more details on these failures, see this check.

Results for commit 3b16df8.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

We don't want to warn on missing docs when a module is hidden,
nor when a function has an `equiv` metadata.
When building Erlang/OTP with warn_missing_docs it was found that
we need more granual warnings. So this commit adds support for
functions, types and callbacks as warnings.
@garazdawi garazdawi merged commit 375ffcd into erlang:master Feb 20, 2024
34 checks passed
@garazdawi garazdawi deleted the lukas/otp/fix-warn_no_docs branch February 20, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:VM Assigned to OTP team VM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants