Skip to content

Remove unnecessary javadoc from test code #3332

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

Closed
quaff opened this issue Jan 25, 2024 · 2 comments
Closed

Remove unnecessary javadoc from test code #3332

quaff opened this issue Jan 25, 2024 · 2 comments
Labels
status: ideal-for-contribution An issue that a contributor can help us with type: task A general task

Comments

@quaff
Copy link
Contributor

quaff commented Jan 25, 2024

Many javadoc of test code are redundant because method/constructor is self-described, for example:

/**
* Creates a new instance of {@code User} with preinitialized values for firstname, lastname, email address and roles.
*
* @param firstname
* @param lastname
* @param emailAddress
* @param roles
*/
public User(String firstname, String lastname, String emailAddress, Role... roles) {

and some are erroneous, for example:

/**
* @param domainClass
* @param entityManager
*/
public CustomGenericJpaRepository(JpaEntityInformation<T, ID> metadata, EntityManager entityManager) {
super(metadata, entityManager);
}

I would help if the team agreed to cleanup.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 25, 2024
@mp911de
Copy link
Member

mp911de commented Jan 25, 2024

I think it makes sense to clean up these bits.

@mp911de mp911de added type: task A general task status: ideal-for-contribution An issue that a contributor can help us with and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 25, 2024
quaff added a commit to quaff/spring-data-jpa that referenced this issue Jan 26, 2024
@quaff
Copy link
Contributor Author

quaff commented Jan 26, 2024

Superseded by #3333

@quaff quaff closed this as completed Jan 26, 2024
quaff added a commit to quaff/spring-data-jpa that referenced this issue Jan 26, 2024
quaff added a commit to quaff/spring-data-jpa that referenced this issue Jan 26, 2024
@christophstrobl christophstrobl added this to the 3.3 M1 (2024.0.0) milestone Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ideal-for-contribution An issue that a contributor can help us with type: task A general task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants