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

Add a dodal glossary and style guide #876

Open
dperl-dls opened this issue Oct 30, 2024 · 0 comments
Open

Add a dodal glossary and style guide #876

dperl-dls opened this issue Oct 30, 2024 · 0 comments

Comments

@dperl-dls
Copy link
Collaborator

dperl-dls commented Oct 30, 2024

There are some things which we have discussed which are not easily enforceable through linting, we should add a document about best practices, e.g.

  • how to use the new Reference to add private references to other devices or signals
  • naming devices and their associated enums
    • enums that live in a device file don't need to include the device name
    • composite devices which exist to expose a synthetic signal should be named after that synthetic signal and not the component devices
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