8000 fix: Fix dangling top-level kdoc comments (#390) by majidhawa · Pull Request #392 · scribe-org/Scribe-Android · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: Fix dangling top-level kdoc comments (#390) #392

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

Merged
merged 3 commits into from
May 5, 2025

Conversation

majidhawa
Copy link
Contributor
@majidhawa majidhawa commented May 2, 2025

Contributor checklist


Description

This pull request adds full KDoc documentation to the be.scri.views.KeyboardView class, including its public methods, properties, and nested interfaces.
Additionally, it suppresses unused private property warnings using @Suppress("UnusedPrivateProperty") to ensure a clean detekt pass while preserving future-use variables.

Testing:

  • Ran ./gradlew detekt successfully
  • All formatting, linting, and YAML checks passed
  • Verified that no functional changes were made to existing logic

Related issue

Copy link
github-actions bot commented May 2, 2025

Thank you for the pull request! ❤️

The Scribe-Android team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider attending our bi-weekly Saturday dev syncs. It'd be great to meet you 😊

Copy link
github-actions bot commented May 2, 2025

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

  • The linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@majidhawa
Copy link
Contributor Author

@andrewtavis @angrezichatterbox could you please review this? 🙏

@andrewtavis
Copy link
Member

We'll get to the review as soon as we can, @majidhawa :) Thanks for the PR!

@andrewtavis andrewtavis self-requested a review May 2, 2025 18:36
Copy link
Member
@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

Thanks for the great work on the docstrings here, @majidhawa! Really has been such a major step for the app to have all of this work done, and will help so many others onboard in the future 😊

@andrewtavis andrewtavis merged commit eb1aafb into scribe-org:main May 5, 2025
5 checks passed
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.

3 participants
0