Ongoing Minor Issue List (OCD list)

phroa commented 10 years ago

Track at https://github.com/SpongePowered/SpongeAPI/pull/860

Minor Issues List

[ ] Discover Minor Issues
[x] SpongeAPI should use quaternions for rotations (provided by flow-math) as they are superior to euler angles and the standard in games. Both options should be provided: what the implementation doesn't support becomes a simple overload (conversions representations are provided by flow-math).
[ ] Have checkstyle warn on missing Override annotation
[x] Secondary ordinal or Secondary cardinal? Javadoc and field name conflict. Direction:30
[x] GameMode javadoc uses fully qualified link to Player
[x] Some method declarations in DataHolder are generic although they don't have to. This leads to worse usability / more raw casts. See comment: https://github.com/SpongePowered/SpongeAPI/issues/221#issuecomment-107156044 appears to have been refactored so I won't touch
[x] GameMode would be better suited in the org.spongepowered.api.data.type package.
[x] AbstractInventoryProperty could extend AbstractProperty. See comment: https://github.com/SpongePowered/SpongeAPI/issues/221#issuecomment-119275472 for more
[ ] Make UseItemStackEvent.Finish not cancellable, don't allow modifying the duration in Stop and Finish (changes won't be reflected anyway)

Checkstyle warnings

File	Problem

caseif commented 9 years ago

GroundLumanceProperty is misspelled (should be GroundLuminanceProperty), and LightEmissionProperty is inconsistently named (it would make more sense to call it LuminanceProperty to match GroundLuminanceProperty and SkyLuminanceProperty.

Also, there should probably be a HumidityProperty for Locations.

ST-DDT commented 9 years ago

[x] Typo fro instead of forin ExperienceHolderData
[x] Unused import ImmutableDataManipulator in ImmutableCareerData

octylFractal commented 9 years ago

[ ] Inventory.slots() should have a signature of <T extends Slot> Iterable<T> slots(); because it always returns Slots. @Mumfrey

TheRaspPie commented 9 years ago

[ ] Location and Transform use setXXX methods for creating new instances with modified data. BlockSnapshot uses withXXX methods. As these methods don't set something but create a new instance, withXXX seems more appropriate here. Needs to be renamed.

ST-DDT commented 9 years ago

[x] Keys - missing ACHIEVEMENTS key

+ public static final Key<SetValue<Achievement>> ACHIEVEMENTS = null;

[x] ImmutableAchievementData - typo

- ImmutableSetValue<Achievement> achiements();
+ ImmutableSetValue<Achievement> achievements();

I can create a PR for this as well, but I consider this a too small/OCD change. Compare/Merge

ghost commented 9 years ago

[ ] PersistingData - typo

- Value<Boolean> perists();
+ Value<Boolean> persists();

gabizou commented 9 years ago

Inventory.slots() should have a signature of Iterable slots(); because it always returns Slots. @Mumfrey

As mentioned here this is a big fat no:

Leaf nodes are currently guaranteed to be Slots but I definitely don't want this encoded in the API, because the entire point of this is that it can support future changes in minecraft's inventory system. This is why pretty much all generic signatures are , because the contract is designed around the core premise that you deal with Inventorys not any particular sub interface.

Mumfrey 2015

ryantheleach commented 9 years ago

[ ] Did blockbuffers get removed / renamed from the API? If so https://github.com/SpongePowered/SpongeAPI/blob/master/src/main/java/org/spongepowered/api/world/gen/WorldGenerator.java needs it's JavaDocs updated.

ryantheleach commented 9 years ago

[x] I wouldn't call this a minor issue, but maybe someone else would: https://github.com/SpongePowered/SpongeAPI/pull/895 Helper method returning wrong Axis

Rain336 commented 9 years ago

[ ] In SleepingEvent change the #wasSpawnSet() into #isSpawnSet() in the JavaDocs

randombyte-developer commented 9 years ago

SPAWNER_REQURED_PLAYER_RANGE - typo

phroa commented 9 years ago

I already fixed that in #860.

JonathanBrouwer commented 9 years ago

https://github.com/SpongePowered/SpongeAPI/blob/master/src/main/java/org/spongepowered/api/entity/living/monster/Creeper.java line 30 creeepr -> creeper

phroa commented 9 years ago

That was also already fixed in my PR.

octylFractal commented 9 years ago

@bloodmc Might need discussion, but things related to BlockTrait values (like getTraitMap) should return ? extends Comparable since all values are Comparable.

For example:

// Current
Map<BlockTrait<?>, ?> getTraitMap();

// Proposed
Map<BlockTrait<?>, ? extends Comparable<?>> getTraitMap();
// or
Map<BlockTrait<?>, Comparable<?>> getTraitMap();

octylFractal commented 9 years ago

~~Inventory.poll() returns ItemStack, but the javadoc claims it can return Optional.empty()! link to relevant line~~ (Fixed)

gabizou commented 8 years ago

@phroa mind updating the issue description of the various OCD things listed here?

ryantheleach commented 8 years ago

[ ] Create Keys.BABY (boolean) and Keys.Adult (boolean)

JBYoshi commented 8 years ago

@ryantheleach I think only one would be needed - the value of one is simply the opposite of the other.

ryantheleach commented 8 years ago

[ ] Add Enderman Carried Data to api. Different from equipment / loot.

TheRaspPie commented 8 years ago

[ ] Scoreboard.java: line 58, blank line missing.

ghost commented 8 years ago

[ ] Keys.EXPLOSIVE_RADIUS, ExplosiveRadiusData and Explosive are inconsistent in whether the explosive radius is a Value<Integer> or a MutableBoundedValue<Integer>. Should be the latter because negative radius makes no sense.

JBYoshi commented 8 years ago