Improve Javadoc Comments for Better Clarity and Accessibility #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ajaynegi45
reviewed
Oct 2, 2024
| */ | ||
| public MemberService(MemberRepository memberRepository, NotificationService notificationService) { | ||
| this.memberRepository = memberRepository; | ||
| this.notificationService = notificationService; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves all members from the database. | ||
| * Retrieves all members from the system. |
There was a problem hiding this comment.
- Retrieves all members from the database.
ajaynegi45
reviewed
Oct 2, 2024
There was a problem hiding this comment.
Hi @Harshmhajn,
Thank you for your prompt work on this issue. I appreciate your involvement in the project.
However, after reviewing your contributions, I noticed that many of the changes mainly focus on rewriting existing English content. I encourage you to focus on making meaningful contributions that add genuine value to the project. It's important to prioritize quality over quantity and avoid making changes that could be seen as spamming the repository.
I appreciate your efforts, and I look forward to seeing more impactful contributions from you in the future! ❤️
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request enhances the Javadoc comments throughout the LibraryMan project to improve clarity and make the documentation more beginner-friendly. These changes aim to help new contributors better understand the codebase and facilitate their contributions.
Key Changes:
Reviewed and simplified existing Javadoc comments across all classes and methods.
Reduced technical jargon and provided clear, straightforward explanations.
Added examples where necessary to demonstrate usage of methods and classes.
Ensured consistency in formatting and language across the documentation.
Followed best practices for writing Javadoc comments, including:
Brief descriptions of the purpose of classes and methods.
Clear explanations of all parameters and return values.
Highlighting any exceptions thrown by methods.
Utilizing relevant tags (e.g., @param, @return, @throws).
Tasks Completed:
Review existing Javadoc comments
Simplify explanations and reduce jargon
Add examples where applicable
Ensure consistent formatting
Follow best practices for Javadoc comments
Additional Notes: I believe these improvements will make the LibraryMan project more accessible to new contributors. Please feel free to ask any questions or request clarifications if needed. Thank you for considering this pull request!