Ongoing Minor Issue List (SpongeAPI Edition)

[Deamon5550]

SpongeAPI | Sponge

Checkstyle issues should not be reported here as those can be more accurately determined by simply running the checkstyle tool. Examples of good issues to report here are misnamed methods/fields, poorly worded javadocs, formatting issues.

As minor things are resolved, comments will be deleted.

[tyhdefu]

https://jd.spongepowered.org/7.2.0/org/spongepowered/api/item/inventory/Inventory.html#offer-org.spongepowered.api.item.inventory.ItemStack- has a very confusing javadoc. It says it returns true if one or more (up to the total number of items in the supplied stack) items were consumed. but the type returned is InventoryTransactionResult.
Not sure if this is intentional, but calling .getRejectedItems() only returns something if the whole stack was rejected, even if it was partially rejected. It seems like theres a mix of mutating the ItemStack and returning a result going on here. I think it should be one or the other.

[NxDs]

{@link Listener}d instead of {@link Listener}s or {@link Listener}

SpongeAPI/src/main/java/org/spongepowered/api/event/Order.java

Line 28 in e36c95a

* Order that {@link Listener}d methods may be registered at.

[Lignium]

Should be CommandCause commandCause or just cause

SpongeAPI/src/main/java/org/spongepowered/api/command/parameter/managed/ValueParameter.java

Line 107 in 4f58aeb

List<CommandCompletion> complete(CommandCause context, String currentInput);

SpongeAPI/src/main/java/org/spongepowered/api/command/parameter/managed/ValueParameter.java

Lines 102 to 103 in 4f58aeb

	* @param context The {@link CommandCause} that contains the parsed
	* arguments

[Lignium]

Returns a {@link WorldProperties}.

SpongeAPI/src/main/java/org/spongepowered/api/command/parameter/managed/standard/ResourceKeyedValueParameters.java

Lines 465 to 467 in 1a5f417

	* <p>Returns a {@link WorldProperties}.</p>
	*/
	public static final DefaultedRegistryReference<ResourceKeyedValueParameter<ServerWorld>> WORLD = ResourceKeyedValueParameters.key(ResourceKey.sponge("world"));

[JonesiBlitz]

Link to docs should be: https://docs.spongepowered.org/stable/en/contributing/guidelines.html

SpongeAPI/CONTRIBUTING.md

Line 5 in 1a5f417

Please check our [Contribution Guidelines in the Sponge Documentation](https://docs.spongepowered.org/en/contributing/guidelines.html) for more information.

[A248]

The minimum Java version for API 9 is 17, but the README on the api-9 branch states otherwise:
https://github.com/SpongePowered/SpongeAPI/blob/api-9/README.md#prerequisites

[DrZoddiak]

This method doesn't need a generic. API 8+

SpongeAPI/src/main/java/org/spongepowered/api/effect/particle/ParticleEffect.java

Lines 167 to 169 in 7946be0

	default <V> Builder scale(Double scale) {
	return this.option(ParticleOptions.SCALE, scale);
	}