Skip to content
This repository has been archived by the owner on May 7, 2022. It is now read-only.

[Docs] Unit of measure for Tilemap dimensions #158

Open
B-Reif opened this issue May 4, 2021 · 1 comment
Open

[Docs] Unit of measure for Tilemap dimensions #158

B-Reif opened this issue May 4, 2021 · 1 comment

Comments

@B-Reif
Copy link
Contributor

B-Reif commented May 4, 2021

From the docs for Builder dimensions, it's not clear what units the dimensions are in. This could potentially be a number of tiles, a number of chunks, or even a number of pixels.

It would help to annotate this method with the unit it's expecting. Since this library expects a variety of different measures in various methods, it could also help to introduce newtypes to describe sizes and units of measure.

EDIT: From the source comments, it looks like it's measured in chunks.

@B-Reif
Copy link
Contributor Author

B-Reif commented May 4, 2021

Opened a small PR (#159) to update the method docs for now.

Using units of measure would cause breaking changes and would have wider implications.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant