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

Is it a tray or a shelf!? #59

Open
3 tasks
julianstirling opened this issue May 19, 2024 · 0 comments
Open
3 tasks

Is it a tray or a shelf!? #59

julianstirling opened this issue May 19, 2024 · 0 comments

Comments

@julianstirling
Copy link
Collaborator

          ... we need to fix all the errant references to `tray` throughout the codebase. I think the "tray" naming convention came from me during the hackathon, but Wakoma uses the term "shelf", so we should fix the codebase to use that term. An example can be found [here](https://github.com/Wakoma/nimble/blob/master/mechanical/components/cadquery/tray_6in.py).

Originally posted by @jmwright in #58 (comment)


The code base uses both tray and shelf. Tray in the codebase also appears to have two meanings. Some times it means the whole shelf. Sometimes the shelf is divided up into the "front plate" and the "tray". Where the front plate is both the actual front plate and also any of the base that sits between the legs, whereas the tray is everything that sits entirely behind the legs (except in some cases when certain code switches are off.. which adds to confusion).

I think we need to:

  • Do some naming standardisation in the existing repo
  • Make a little diagram to explain the naming
  • Enforce naming when doing code review
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

1 participant