Skip to content

Commit

Permalink
"Improved documentation for MapIterate class"
Browse files Browse the repository at this point in the history
  • Loading branch information
@BrijeshPatra
BrijeshPatra committed Aug 22, 2023
1 parent 2472e62 commit ad4119e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions eclipse-collections/src/main/java/org/eclipse/collections/impl/utility/MapIterate.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
* making your code more concise and readable.
* This utility class is especially useful when you want to return a MutableMap as a result of your operations.
* Explore the capabilities of MapIterate to streamline your data manipulation tasks when working with maps. It is a versatile tool in your Java development toolkit.
*/

package org.eclipse.collections.impl.utility;
Expand Down

3 comments on commit ad4119e

@BrijeshPatra
Copy link
Author

@BrijeshPatra BrijeshPatra commented on ad4119e Aug 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Description

Hello, @sullis @gastaldi @valery1707 @brunoborges @Godin

This pull request addresses the clarity and comprehensibility of the documentation for the MapIterate class in the org.eclipse.collections.impl.utility package. The current summary mentioning the "Smalltalk Collection Protocol" may not be familiar to most Java developers, and the documentation lacks specificity about the class's purpose in working with Java's java.util.Map objects.

Changes Made

  • Updated the summary of the MapIterate class to emphasize that it operates on java.util.Map objects.
  • Clarified the class's purpose in working with associative arrays and performing common tasks with maps.
  • Retained the rest of the documentation, which remains relevant and informative.

Reason for Changes

The goal is to make the documentation more user-friendly and accessible to a wider audience of Java developers. By clearly stating that MapIterate is designed for working with java.util.Map objects, we aim to improve the understanding of the class's purpose.

Testing

This change does not impact the functionality of the code but focuses solely on improving documentation clarity. Manual testing of the documentation in the source code and generated documentation was performed.

Related Issue

This pull request is related to issue #1491.

Your feedback and review are highly appreciated. Please let me know if there are any further changes or improvements needed.

Thank you for considering this contribution!
Brijesh Patra

@brunoborges
Copy link
Contributor

Choose a reason for hiding this comment

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

You added javadoc to the header of the file, which only covers the license and copyright statements.

I suggest you add the proper Javadoc to the class type definition. See java.lang.String source code as an example.

@BrijeshPatra
Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the comment sure I will update it.

Please sign in to comment.