yarn icon indicating copy to clipboard operation
yarn copied to clipboard

JavaDoc grammar issue: 'Emits an game event'

Open andantet opened this issue 2 years ago • 2 comments

The sentence 'Emits an game event' should read 'Emits a game event'.

https://github.com/FabricMC/yarn/blob/5a3bdbd522adfa5ad26bd4220ce5ca7cfefff269/mappings/net/minecraft/world/WorldAccess.mapping#L7

andantet avatar Jul 09 '22 14:07 andantet

That sentence does not add useful information to be honest. It's repeating the method name.

enbrain avatar Jul 11 '22 15:07 enbrain

I think there's still some value in providing javadoc for such methods; the ability to show that a method is noteworthy is one of the benefits.

apple502j avatar Jul 11 '22 18:07 apple502j