Skip to content

Add docstring to Keyword data class#643

Open
Lang-Qiu wants to merge 1 commit into
Arturo254:masterfrom
Lang-Qiu:auto-pr/docstrings-1780787264
Open

Add docstring to Keyword data class#643
Lang-Qiu wants to merge 1 commit into
Arturo254:masterfrom
Lang-Qiu:auto-pr/docstrings-1780787264

Conversation

@Lang-Qiu

@Lang-Qiu Lang-Qiu commented Jun 6, 2026

Copy link
Copy Markdown

Problem

The Keyword data class in the kugou module is a public component but lacks documentation, which negatively impacts code readability and maintainability. Clear documentation is essential for developers to understand the purpose and structure of this class.

Changes

  • Added a Kotlin docstring to the Keyword class, describing its role as a data class that holds keyword information including title and artist fields.
  • The documentation follows Kotlin conventions and does not alter any existing code structure or functionality.

Verification

  • Review the added docstring to ensure it accurately reflects the class's purpose and fields.
  • Since this is a documentation-only change, no functional tests are required; however, existing tests can be run to confirm no regressions were introduced. The change is minimal and backward-compatible.

@codesandbox

codesandbox Bot commented Jun 6, 2026

Copy link
Copy Markdown

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@RajnishKMehta

Copy link
Copy Markdown
Contributor

Given that Keyword is a simple two-field data class, I'm not sure the added documentation provides much additional value.

Additionally, the new docstring appears to be written in Chinese. Most code comments and documentation in the project are written in English, so it would be preferable to keep this docstring in English for consistency.

@Arturo254 Arturo254 marked this pull request as ready for review June 9, 2026 19:30
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