Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation of public members #32

Open
StatisMike opened this issue May 3, 2024 · 0 comments · May be fixed by #33
Open

Better documentation of public members #32

StatisMike opened this issue May 3, 2024 · 0 comments · May be fixed by #33

Comments

@StatisMike
Copy link

Documentation of the public members of the crate is really sparse. Example in wfc_image makes the implementation a little easier to understand, but I personally don't find it straightforward.

I am currently in process of implementing WFC algorithm in my crate and will compare my implementation to the one derived from this crate. After successfully implementing it over grid type in my crate, I can try to open a PR with some additional documentation - would it be welcome?

@StatisMike StatisMike linked a pull request May 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant