Improve documentation of nullability on LoggingEvent interface #446
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.
I recently worked with the SLF4J
LoggingEvent
interface, and found myself having to dig through theDefaultLoggingEvent
implementation to see which methods onLoggingEvent
could actually returnnull
. I saw that there is an existing docstring documenting the nullability ofLoggingEvent.getMarkers()
, but none for the other methods. I figured it would be useful to document this on all methods, to make the interface contract clearer.The existing
LoggingEvent.getMarkers()
docstring duplicated its text in the main doc and in@return
. This seemed redundant to me, but if you prefer this format I'll change over to it.I figured that for a small change like this it would be easiest to submit a PR directly, so I didn't go through the mailing list/bug report. But I'll do that if you prefer strictly following the contributor guidelines.