improve visibility of table rows in javadoc #358
Merged
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
Signed-off-by: Nathan Rauh <[email protected]>
njr-11
force-pushed
the
228-improve-visibility-of-table-rows-in-javadoc
branch
from
f34d104 to
2d1e539
Compare
otaviojava
approved these changes
Nov 16, 2023
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.
It is difficult to visually identify one row from the next in tables within the JavaDoc. This pull adds shading for alternate rows to make the documentation readable. Unfortuntately the nth-child(even) approach to automatic applying across the table requires the style element which is not allowed in JavaDoc, so I had to specify explicitly on each row, which is more tedious but has the same improvement for the reader.
Also, I spotted outdated references to "find..." that refer to a predecessor of the Automatic Query Methods / parameter-based conditions. This pattern now allows for flexible naming of methods (they don't need to begin with find... anymore), so I removed those references from the table and added an explanation of how to locate the information in the table for the flexible-named methods.