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

Higher and lower level components is confusing #26

Open
calebeby opened this issue Sep 6, 2016 · 5 comments
Open

Higher and lower level components is confusing #26

calebeby opened this issue Sep 6, 2016 · 5 comments
Labels
documentation Improvements or additions to documentation magicbot magicbot package

Comments

@calebeby
Copy link
Contributor

calebeby commented Sep 6, 2016

Hi @virtuald and @PeterJohnson,
I think it's confusing that there are higher and lower level components. I like the way that @frc1418 had components and automations. I think updating this in the docs would make it easier for beginners to understand the difference, and it would be good for them to live in separate folders.

@virtuald
Copy link
Member

virtuald commented Sep 6, 2016

Is it the wording that's confusing or the concept?

@calebeby
Copy link
Contributor Author

calebeby commented Sep 6, 2016

The wording

@virtuald
Copy link
Member

virtuald commented Sep 6, 2016

Ok, that's fair then.

I'm not quite sure how I feel about using the word 'automations'. I chose 'components' and 'controllers' for my rewrite of 2423's code.

It's probably a good idea to add a note that it's useful to separate them into different folders. Though, worth noting that the magicbot sample only has a components directory -- does that mean we should add a more complex magicbot example?

I'm working on other things, but in the meantime feel free to edit it yourself and submit a PR to clarify it. :)

@calebeby
Copy link
Contributor Author

calebeby commented Sep 7, 2016

Regarding the name, personally, I prefer automations, because you are connecting more than one component together.

Regarding examples, reading 1418's code has been more helpful for me than the samples because it has real parts, like intake, winch, and drive, instead of component1 and component2.
I definitely think it would be helpful to create a more realistic example that is simpler than 1418's code.

I am currently programming a robot for BunnyBots, and once that season is over (middle of December) I would be willing to add it as an example.

@ErikBoesen what do you think about the naming? Do you prefer automations, controllers, or something else?

@ErikBoesen
Copy link

I don't have a strong opinion on this, but if I had to choose I'd go with "automations," even though it's rather confusing when combined with autonomous.

@auscompgeek auscompgeek added magicbot magicbot package documentation Improvements or additions to documentation labels Sep 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation magicbot magicbot package
Projects
None yet
Development

No branches or pull requests

4 participants