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

[discussion] make position of pin numbers within connectors consistent? #404

Open
formatc1702 opened this issue Jul 12, 2024 · 7 comments
Open

Comments

@formatc1702
Copy link
Collaborator

formatc1702 commented Jul 12, 2024

Split of from #286 (comment) , image taken from there

image

Currently, pin numbers appear on the left or the right of the connector's pin table depending on which side the wires come out.

This was implemented since the very first draft of WireViz and has remained unchanged. As more and more fields can/will be defined on a pin level (pin labels, color, notes, shorts/bridges, ...), it can cause confusion.
And when daisy-chaining connectors horizontally, duplicating the pin number on both edges can look silly, especially if no other pin attributes are defined.

Should pin numbers always appear on the left, to keep the order of the columns consistent across all connectors?
Personally, I am leaning more and more in favor of this solution.

@AlanLivingston
Copy link

I use these wireviz drawings to document cabling and to assist technicians with construction cables. Our techs like the pin numbers next to the wires, as that's the information they use most when making the cable. Many times, they don't care about or refer to the signal name. I'd prefer to move the signal names into the rightmost column after the shorts, so that it's a mirror image of the left connector.

@martinrieder
Copy link
Contributor

Some thought that I have been considering to post as a feature request recently: Currently, pin activation takes effect on both sides of the connector, causing the entire pin list to be shown on whichever side there is any connection. Should it also be possible to show individual pin listings on the left and right side of connectors? Or would it just overcomplicate things?

@formatc1702
Copy link
Collaborator Author

Our techs like the pin numbers next to the wires, as that's the information they use most when making the cable.

That was the thinking behind the initial behavior :)

@martinrieder
Copy link
Contributor

I wrote #404 (comment) under the assumption that hide_disconnected_pins is active. IMO this should treat both sides independently to produce a more compact output. Any opinions on this?

@tobiasfalk
Copy link

First, I would not talk about left and right but rather see it like an onion, with a core, outside, and inside (currently empty) layers. Currently, the outside layer is always th Nr. and then the core goes lable and jumpers

Second, I think that this outside and inside layers are mirrored if wiers are connected to both sides of the connector.

It would be reasonable to put the lable into the first inside layer.

It would also be good if it would be selectable if these layers are always left, right, both sides or auto(similar to current).

It would also be reasonable if it would be possible to select if the lable is part of the core or layer.

I think that things like the jumpers should remain in the core.

@kvid
Copy link
Collaborator

kvid commented Sep 12, 2024

@martinrieder wrote:

I wrote #404 (comment) under the assumption that hide_disconnected_pins is active. IMO this should treat both sides independently to produce a more compact output. Any opinions on this?

  • When hiding disconnected pins, it makes sense to hide the whole row because no information about those pins are needed.
  • Pins that are connected at one side and have no wire at the other side in the diagram, are indeed connected in real life, and all information about them are needed. Do you want to replace the pin name at the no-wire-side with an empty cell? That will not be more compact, so I don't really see the benefit. Please elaborate.

@kvid
Copy link
Collaborator

kvid commented Oct 22, 2024

  • Personally, I like the pin names close to the wire ends (at both sides when needed) for the same reason as described by @AlanLivingston above.
  • Technically, the wire splines need named ports as anchors to align the wire ends with the correct pin rows. These ports must be the leftmost cells for left-side wires and rightmost cells for right-side wires. Together with the point above, the easy choice is to keep the pin name cells as such ports, as is done today.

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

5 participants