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

specify sealion-power-module subcomponents #178

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

obviously-i
Copy link
Collaborator

Close #176

@obviously-i obviously-i marked this pull request as draft October 21, 2021 20:34
{
"name": "battery-pack",
"version": "0.1.0",
"description": "Physically holds 10 onboard batteries in 5S2P configuration to deliver electrical power to EPS Board.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description should be a human-readable version of the name

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though, I also like having this verbiage as a sort of annotation for the component, so let's copy this verbiage to a docs field; i.e., create a line under description called docs with the above verbiage, i.e.,

"docs": "Physically holds 10 onboard batteries in 5S2P configuration to deliver electrical power to EPS Board.",

I know docs isn't in the official DOF spec, but it's something that's come up as a worth while keyword to be adopted

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same goes for the 11 other package.json files

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On second thought, these notes should go in the notes field in the parts.yaml

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 this pull request may close these issues.

specify sealion-power-module subcomponents
2 participants