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

Some terminology suggestions #26

Open
hooperbloob opened this issue Dec 4, 2018 · 1 comment
Open

Some terminology suggestions #26

hooperbloob opened this issue Dec 4, 2018 · 1 comment

Comments

@hooperbloob
Copy link
Contributor

Just reviewed the library spec (https://developers.librepcb.org/df/d4f/doc_library.html) These are great diagrams btw, I have a few suggestions:

Make the headings on the examples larger so they stand out. (The text at the top of the boundaries shown in grey)

'Splitted' - an awkward use of the term 'split' Would suggest using something like 'Separate', 'Separated', or 'Individual' instead.

'AllInOne' --> 'Combined'

'ReflowSoldering', 'WaveSoldering' - this is awkward as well in its verb form when it should be an adjective. Use ReflowSoldered, WaveSoldered instead. Reminds me of how the French mangled the term 'shampoo' and stuck 'ing' on their translation of it. : )

Minor: some labels are shown in CamelCase, others use whitespace to separate words. The former are class/interface names, the latter ones are just labels? Might need a consistency check or render them differently.

@ubruhin
Copy link
Member

ubruhin commented Dec 4, 2018

Actually these diagrams are only made for developers ;) But maybe it would make sense to also add them to the users manual, but with some simplifications and improvements (like the ones you suggested).

I think we should first write clear library guidelines. Afterwards (when it's clear how libraries should look like), the diagram can be updated to match the guidelines :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants