Giters

eclipse / eclipse-collections

Eclipse Collections is a collections framework for Java with optimized data structures and a rich, functional and fluent API.

Home Page:http://www.eclipse.org/collections

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MapIterate JavaDoc: unclear description

Chealer opened this issue · comments

commented

The org.eclipse.collections.impl.utility package summary shows the following as the summary for the MapIterate class:
The MapIterate class provides a few of the methods from the Smalltalk Collection Protocol.

I do not know much about Smalltalk, but I know very few Java developers will know about the Smalltalk Collection Protocol, whatever that is (a Google search seems to indicate this package summary is the most relevant on the topic).
Moreover, it would clarify a lot to indicate that this operates on java.util.Map objects.

I suggest:

This utility class facilitates iteration over associative arrays based on Map objects, especially if there is a desire to return a MutableMap.

By the way, the rest of the description is very relevant and could also help in ListIterate's description.

commented

Hello, @Chealer

I hope you're doing well. I came across this issue and find it interesting. I'd like to contribute to this project by working on it. Could you please assign this issue to me, or provide guidance on how I can get started with it?

I'm excited about the opportunity to collaborate and make a meaningful contribution to this open-source project. I am confident that I can help resolve this issue effectively.

Looking forward to your response and the chance to work together.

Best regards,
Brijesh Patra

commented

Thanks @BrijeshPatra
Unfortunately I can't assign any issue, nor can I provide much guidance.

commented

Thanks for your commits @BrijeshPatra the content is good but I'm pretty sure this won't have the desired result. The JavaDoc (which follows imports) is what needs to be modified. What you are modifying is the copyright header.
By the way, I would recommend not integrating the paragraph added in the last commit. The Eclipse "project" is not commercial and this sounds like an advertisement. The goal is to describe the class, not to encourage developers to use it regardless of their needs.