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.

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

Remove collection from array description #2843

Merged
merged 5 commits into from
Nov 6, 2024
Merged

Conversation

lcsvoj
Copy link
Contributor

@lcsvoj lcsvoj commented Oct 24, 2024

pull request

Updated the description of Java arrays to avoid confusion with the term "collection" as used in the Java Collections Framework. Previously, the text referred to arrays as collections, which is inaccurate in Java's formal terminology.

Native Java arrays are not part of the Collections Framework, as they do not implement the Collection interface or its subtypes, such as List, Set, or Map. They are simply fixed-size objects that hold elements of the same type.

I have rephrased the description to make it more accessible for those who are new to Java, avoiding excessive technical jargon while still preventing misunderstandings and aligning the explanation with Java's official definitions.


Reviewer Resources:

Track Policies

Updated the description of Java arrays to avoid confusion with the term "collection" as used in the Java Collections Framework. Previously, the text referred to arrays as collections, which is inaccurate in Java's formal terminology.

The native Java arrays are not part of the Collections Framework, as they do not implement the `Collection` interface or its subtypes, such as `List`, `Set`, or `Map`. They are simply fixed-size objects that hold elements of the same type.

This change helps prevent misunderstanding and aligns the description with Java's official definitions.
Copy link
Member

@kahgoh kahgoh left a comment

Choose a reason for hiding this comment

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

Hi @lcsvoj ! The proposed changes look fine to me and I generally agree with removing the references to "collection" from arrays.

However, there are a couple of other files we should update as they have the same problem. We should be able to copy and paste the proposed change. Could you also update them? They are:

Updated the description of Java arrays to avoid confusion with the term "collection" as used in the Java Collections Framework. Previously, the text referred to arrays as collections, which is inaccurate in Java's formal terminology.

The native Java arrays are not part of the Collections Framework, as they do not implement the `Collection` interface or its subtypes, such as `List`, `Set`, or `Map`. They are simply fixed-size objects that hold elements of the same type.

This change helps prevent misunderstanding and aligns the description with Java's official definitions.
@lcsvoj
Copy link
Contributor Author

lcsvoj commented Nov 5, 2024

Hello, @kahgoh!

I have made the requested changes to the pull request #2843, updating the cited files.
Sorry for not noticing the need for those changes before being pointed out.

@kahgoh kahgoh added the x:size/small Small amount of work label Nov 6, 2024
Copy link
Member

@kahgoh kahgoh left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for raising the PR!

@kahgoh kahgoh changed the title Clarify distinction between arrays and collections Stop describing arrays as collections Nov 6, 2024
@kahgoh kahgoh changed the title Stop describing arrays as collections Remove collection from array description Nov 6, 2024
@kahgoh kahgoh merged commit b7505e4 into exercism:main Nov 6, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:size/small Small amount of work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants