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

Confusing rafx_visibility and rafx_framework::visiblity exported as rafx::visibility #166

Closed
zicklag opened this issue Jun 15, 2021 · 3 comments

Comments

@zicklag
Copy link
Contributor

zicklag commented Jun 15, 2021

I was just going through the crate docs and noticed a rather confusing module set, where the rafx_visibility crate is re-exported as rafx::rafx_visibility, but the rafx_framework::visibility module is re-exported as rafx::visibility. I'm not sure yet what the differences between the pieces are so I can't suggest any less confusing way to set it up yet, but once I get into it I might submit a PR for a different organization.

@aclysma
Copy link
Owner

aclysma commented Jun 15, 2021

The history of it is that there used to be a rafx_visibility crate, then I pulled it into the rafx_framework crate to reduce modules, and then @DVD added the crate back when he implemented an actual visibility algorithm.

@DVD do you have any thoughts or ideas for how we could name this. I personally don't feel we should bother changing this unless we have an idea we're pretty happy with. Long-term, both these crates/modules will be internal details that few people will ever touch.

@zicklag
Copy link
Contributor Author

zicklag commented Jun 15, 2021

If this is all in flux and going to change later anyway, I'm not opposed to leaving it how it is. I'm always pushing towards very tidy and easy-to-understand documentation and organization, but I totally get it if this is all work-in-progress and it's not worth spending time on this yet.

@aclysma
Copy link
Owner

aclysma commented Jul 1, 2021

Going to close for the time being, I want to delay final decisions for naming/crate layout until later on when we've been able to do more road-testing of these systems.

@aclysma aclysma closed this as completed Jul 1, 2021
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

No branches or pull requests

2 participants