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.

Sign up for GitHub

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

Jump to bottom

Remove missing_docs SwiftLint exclusions where appropriate #630

Open
lawrence-forooghian opened this issue Mar 21, 2023 · 1 comment
Open

Remove missing_docs SwiftLint exclusions where appropriate #630

lawrence-forooghian opened this issue Mar 21, 2023 · 1 comment
Labels
code-quality Affects the developer experience when working in our codebase.

Comments

@lawrence-forooghian
Copy link
Collaborator

In #629 I re-enabled the missing_docs rule, which checks that public declarations have documentation. In order to do so, I had to add swiftlint:disable comments to address the many existing undocumented declarations in the codebase. The vast majority of these are things that should be documented, so let's do so.
@lawrence-forooghian lawrence-forooghian added the code-quality Affects the developer experience when working in our codebase. label Mar 21, 2023
lawrence-forooghian added a commit that referenced this issue Mar 21, 2023
@lawrence-forooghian
Re-enable missing_docs SwiftLint rule
026161d 
I disabled this one in 03dcf6a to get SwiftLint passing.

I’ve added a load of swiftlint:disable comments so that it ignores our
currently-undocumented public declarations. This way we can enable the
rule and make sure that all new public declarations get documented. I’ve
created issue #630 to make sure that we address the
currently-undocumented stuff.
@sync-by-unito
Copy link

sync-by-unito bot commented Mar 21, 2023

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3473

lawrence-forooghian added a commit that referenced this issue Mar 22, 2023
@lawrence-forooghian
Re-enable missing_docs SwiftLint rule
6991875 
I disabled this one in 03dcf6a to get SwiftLint passing.

I’ve added a load of swiftlint:disable comments so that it ignores our
currently-undocumented public declarations. This way we can enable the
rule and make sure that all new public declarations get documented. I’ve
created issue #630 to make sure that we address the
currently-undocumented stuff.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code-quality Affects the developer experience when working in our codebase.
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lawrence-forooghian