Clarify API naming scheme #2

New issue

Closed

opened 2023-03-24 20:52:30 +01:00 by Machine-Maker · 1 comment

Machine-Maker commented

2023-03-24 20:52:30 +01:00

(Migrated from github.com)

Also, the term RegionisedScheduler doesn't seem to mesh with GlobalRegionScheduler and EntityScheduler. Those aren't GlobalisedRegionScheduler or EntitisedScheduler. I think the names for different schedulers should be RegionScheduler, GlobalScheduler, and EntityScheduler removing this problem with s and z in the first place.

I think the type naming is inconsistent, with itself, and with other aspects of the existing API. To be clear, I don't care which we go with, but I do feel that consistency is important for an API (not as big a deal for the impl). The API uses `z` instead of `s` in types already, like `FertilizeEggEvent` and `oxidized` relating to copper. The API isn't consistent with itself already, like `Effect#OXIDISED_COPPER_SCRAPE` but I feel like we should push for consistency in all new things. Also, the term `RegionisedScheduler` doesn't seem to mesh with `GlobalRegionScheduler` and `EntityScheduler`. Those aren't `GlobalisedRegionScheduler` or `EntitisedScheduler`. I think the names for different schedulers should be `RegionScheduler`, `GlobalScheduler`, and `EntityScheduler` removing this problem with `s` and `z` in the first place.

👀 1

kennytv commented

2023-03-25 00:25:47 +01:00

(Migrated from github.com)

github.com/PaperMC/Folia@dfc157075a

https://github.com/PaperMC/Folia/commit/dfc157075abff60c5d0365e2ad566a4fb13220f8