WhoCraft / TardisRefined

A Minecraft mod for Forge and Fabric which brings the TARDIS from Doctor Who to Minecraft.
Other
58 stars 23 forks source link

Exposing more functions #183

Closed leafreynolds closed 11 months ago

leafreynolds commented 11 months ago

Changes Proposed

Adding getters for the following:

Why

I would like these to have public accessors, to provide more information to the user in a ComputerCraft peripheral. More information is always a positive thing ♥

leafreynolds commented 11 months ago

Thanks for this leaf, good to hear from you again! Can you please add documentation about what the getter does and what value it provides?

Hey hey. When you say documentation, are you meaning adding it above the function? or adding more information to this pull request specifically. Very few of the functions in TardisRefined contain function documentation, but happy to add them if needed.

For me, the value that exposing private variables provides is largely geared towards exposing information for a computercraft peripheral addon. The more information we can access, the better ♥

50ap5ud5 commented 11 months ago

Thanks for this leaf, good to hear from you again! Can you please add documentation about what the getter does and what value it provides?

Hey hey. When you say documentation, are you meaning adding it above the function? or adding more information to this pull request specifically. Very few of the functions in TardisRefined contain function documentation, but happy to add them if needed.

For me, the value that exposing private variables provides is largely geared towards exposing information for a computercraft peripheral addon. The more information we can access, the better ♥

Documentation in the relevant java files in the form of comments, please. Yes, many of our functions are undocumented, it's an unfortunate side effect of the mod moving so fast from a prototype to a functional release without much cleanup so far. Helping us with this would be appreciated. We are also looking to refactor things and document functions going forward in 1.20, but that has not been released yet.

A summary of getters you added in this PR's description would be great too. Thanks!

Jeryn99 commented 11 months ago

I am happy to approve this if @50ap5ud5 is