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

[internal] Change names of connector attributes #77

Closed
formatc1702 opened this issue Jul 11, 2020 · 0 comments
Closed

[internal] Change names of connector attributes #77

formatc1702 opened this issue Jul 11, 2020 · 0 comments
Assignees
Milestone

Comments

@formatc1702
Copy link
Collaborator

The names of connectors' attributes will be changed to ease confusion.

  • pinnumbers will be changed to pins
  • pinout will be changed to pinlabels

Quoting an earlier discussion in #71:

  • pins (previously known as pinnumbers) is the list of unique identifiers for each pin, and is autofilled with [1,2,...,<pincount>] when it not specified explicitly. It is useful for non-numerical pinout schemes like [tip,ring,sleeve], an alphanumerical matrix ([A1,A2,...B1,B2,...]) and others, and to manually reorder pin numbers if so desired ([4,1,3,2]).
  • pinlabels (previously known as pinout) allows assigning labels to each pin, e.g. it's function (VCC, GND, ...). It is autofilled with ''and hidden if not specified.

This makes things more consistent by using plural words for lists (pins,pinlabels, a wire's colors, ...) [...]

  • pinlabels do not have to be unique, but can only be used for defining connections if the ones being used are unambiguous
@formatc1702 formatc1702 self-assigned this Jul 11, 2020
formatc1702 added a commit that referenced this issue Jul 19, 2020
Rename `pinnumbers` to `pins`.
Rename `pinout` to `pinlabels`.
@formatc1702 formatc1702 added this to the v0.2 milestone Jul 19, 2020
formatc1702 added a commit that referenced this issue Jul 21, 2020
Rename `pinnumbers` to `pins`.
Rename `pinout` to `pinlabels`.
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