Skip to content

Conversation

@blerer
Copy link
Contributor

@blerer blerer commented Dec 15, 2021

…g query checks

Copy link
Contributor

@maedhroz maedhroz left a comment

Choose a reason for hiding this comment

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

LGTM, aside from some minor nits that you can take or leave

}

/**
* Checks that the specified expression is <code>true</code>. If not an <code>InvalidRequestException</code> will
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: It might be nice to use @link rather than code so things are navigable?

Copy link
Contributor Author

@blerer blerer Dec 20, 2021

Choose a reason for hiding this comment

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

The issue with link is that you can end up with a javadoc with a lot of link that made the generated javadoc harder to read. The general approach is to use simply use {@code } in the methods. I would prefer if we stick with the most common approach.

* @param messageTemplate the template used to build the error message
* @param messageArgs the message arguments
* @param messageArg the message argument
* @throws InvalidRequestException if the specified expression is <code>false</code>.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Might be easier to read quickly with a newline between the last @params and the first @throws

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried and felt that it was making the javadoc longer specially if I did the same when there was a @return. I checked the java classes javadoc and they do not use new line there so I decided to keep it this way.

blambov pushed a commit to blambov/cassandra that referenced this pull request Feb 20, 2025
We want to run the common tests in the subclasses of the abstract class, but not in the abstract class itself.
michaelsembwever pushed a commit to thelastpickle/cassandra that referenced this pull request Jan 7, 2026
We want to run the common tests in the subclasses of the abstract class, but not in the abstract class itself.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants