Skip to content

Conversation

@LalitNarayanYadav
Copy link
Contributor

Problem

The generic parameter Type in the AnyContains interface was not documented, which caused confusion for users and contributors about its purpose and usage.

Solution

Added a clear and detailed Javadoc description for the Type generic parameter in the AnyContains interface. This documentation explains what Type represents, how it relates to the contains method, and how implementations should handle type safety via isSafeToCheck.

Testing Completed

Reviewed the updated Javadoc locally to ensure clarity and correctness. No functional code changes were made, so no unit tests were necessary.

Supporting Information

This change improves code readability and developer experience by clarifying the usage of generics in the AnyContains interface.

Completes: #7902
Related: none

@LalitNarayanYadav LalitNarayanYadav requested review from a team as code owners June 4, 2025 19:28
@LalitNarayanYadav LalitNarayanYadav requested review from Burbulinis and UnderscoreTud and removed request for a team June 4, 2025 19:28
@skriptlang-automation skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Jun 4, 2025
@APickledWalrus APickledWalrus moved this to Needs Reviews in 2.12 Releases Jun 4, 2025
@Efnilite Efnilite changed the base branch from master to dev/feature June 4, 2025 19:54
@skriptlang-automation skriptlang-automation bot added feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version. and removed needs reviews A PR that needs additional reviews labels Jun 4, 2025
@Efnilite
Copy link
Member

Efnilite commented Jun 4, 2025

just a note for future PRs: you should make it target the dev/patch branch when creating bug fixes or the dev/feature branch for features and breaking changes. thanks for contributing!

@LalitNarayanYadav
Copy link
Contributor Author

Thanks @Efnilite ! I will keep it in mind while contributing next time.

@APickledWalrus APickledWalrus linked an issue Jun 4, 2025 that may be closed by this pull request
1 task
@Efnilite Efnilite moved this from In Review to Awaiting Merge in 2.12 Releases Jun 8, 2025
@Burbulinis Burbulinis merged commit 0bce469 into SkriptLang:dev/feature Jun 9, 2025
5 checks passed
@github-project-automation github-project-automation bot moved this from Awaiting Merge to Done in 2.12 Releases Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version.

Projects

Status: Done - Released

Development

Successfully merging this pull request may close these issues.

Include a definition of "Type" in AnyContains Javadocs

5 participants