fix(missing_docs): treat actors as inheriting Actor#6648
Open
leno23 wants to merge 1 commit into
Open
Conversation
Generated by 🚫 Danger |
SimplyDanny
requested changes
May 19, 2026
Collaborator
SimplyDanny
left a comment
SimplyDanny
left a comment
There was a problem hiding this comment.
The changes are causing way too many findings in OSS projects. Please review the scope of your implementation. The rule should only skip known actor properties/functions (by default).
Author
|
Thanks for the review @SimplyDanny — I've pushed an update that narrows the scope:
This should avoid the OSS-wide noise from skipping all actor children. |
leno23
force-pushed
the
fix/missing-docs-implicit-actor-5422
branch
from
e89b693 to
74fd35d
Compare
leno23
added a commit
to leno23/SwiftLint
that referenced
this pull request
May 31, 2026
Skip missing_docs for configurable Actor inherited members (default: unownedExecutor) inside actors without explicit `: Actor` conformance. Addresses review feedback on realm#6648.
Author
|
Pushed another update per review:
Happy to adjust the default list if you have other common members in mind. |
Author
|
@SimplyDanny The latest push includes |
…tors Add excluded_implicit_actor_members configuration (default: unownedExecutor) for actors without explicit `: Actor` conformance when excludes_inherited_types is enabled. Explicit `: Actor` still uses skipChildren for all members. Fixes realm#5422
leno23
force-pushed
the
fix/missing-docs-implicit-actor-5422
branch
from
3fb1d09 to
f4f070c
Compare
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
3 participants
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
excludes_inherited_typesis enabled (the default),missing_docsnow skips members insideactordeclarations, matching behavior for types with explicit inheritance.Actorprotocol, so members likeunownedExecutorshould not require documentation when inherited types are excluded.Fixes #5422
Test plan
nonisolatedmemberexcludes_inherited_types: false