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

Peers window Peer id improvements #290

Closed
wants to merge 2 commits into from

Conversation

jonatack
Copy link
Member

@jonatack jonatack commented Apr 23, 2021

This patch:

  • renames the peers tab column header from Peer Id to Peer to allow resizing the column more tightly (this will be particularly useful after Save/restore column sizes of the tables in the Peers tab #256) and does the same for the peer details area.

  • center-aligns the entries in the Peer column to align them under the column header rather than to the left (I also tried right-alignment but the values are unreadably close to the Address values and it seems more esthetic to be aligned under the header 🗄️)

Screenshot from 2021-04-23 16-43-21

@hebasto hebasto added the Design label Apr 23, 2021
@RandyMcMillan
Copy link
Contributor

Tested on MacOS 10.14.6 (18G103)

Screen Shot 2021-04-23 at 2 39 25 PM

Copy link

@Talkless Talkless left a comment

Choose a reason for hiding this comment

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

tACK e14d79f, tested on Debian Sid with Qt 5.15.2.

@Talkless
Copy link

renaming to Id instead of Peer would work also but I'm not sure about translateability

What are the concerns exactly?

@kristapsk
Copy link
Contributor

renaming to Id instead of Peer would work also but I'm not sure about translateability

"Id" seems to be a short for "Identifier" in most of the languages I checked. Are there exceptions for that and languages where "Id" can't be translated to something similar? https://en.wikipedia.org/wiki/ID

@jonatack
Copy link
Member Author

"Id" is actually incorrect (I think you are referring to "ID"). Outside of databases and developers, "Id" is a somewhat confusing word to use because it has many meanings. See https://www.thefreedictionary.com/id. The link you gave also lists many definitions. It is also an acronym for many different things. For these reasons, I proposed "Peer" to see what reviewers think.

@jonatack
Copy link
Member Author

jonatack commented Apr 25, 2021

(Dropped the "Id" part from the PR description.)

case Address:
return {};
case NetNodeId:
Copy link
Member

Choose a reason for hiding this comment

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

In e14d79f

Why move the position of NetNodeId here? In the other areas of the code, NetNodeId always comes before Address in our switch statements. I don't think we should move it here.

You can keep it where it originally is and do:

Suggested change
case NetNodeId:
case NetNodeId:
return QVariant(Qt::AlignCenter);

Copy link
Member Author

@jonatack jonatack Apr 25, 2021

Choose a reason for hiding this comment

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

Generally I prefer to propose the smaller, simpler diff. The order doesn't matter here and it seems better to group the cases by alignment.

Copy link
Member

Choose a reason for hiding this comment

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

It's not much of a difference, plus this makes it easier to reason about. You are explicitly stating that you are making it AlignCenter. I'd prefer we keep the same order as our other switch statements, but it's not a strong opinion.

Copy link
Member

Choose a reason for hiding this comment

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

Always keeping the same order of enum elements in switch statement could decrease mental burden for some ppl :)

Copy link

Choose a reason for hiding this comment

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

Ditto, diff is only for "once" (for review), while people will read this switch multiple times in the future, so I'm also for same ordering.

@jarolrod
Copy link
Member

ACK e14d79f

% nit about switch statement order

@hebasto
Copy link
Member

hebasto commented Apr 30, 2021

renaming to Id instead of Peer would work also but I'm not sure about translateability

btw, a good translation of a noun "peer" that means "a participant of the peer-to-peer network" could be a real challenge, at least in some languages 😃

@maflcko
Copy link
Contributor

maflcko commented Apr 30, 2021

Is there a way to tell translators synonyms? "Connection" might be easier to translate.

@jonatack
Copy link
Member Author

Is there a way to tell translators synonyms? "Connection" might be easier to translate.

Yes, could mention synonyms like "connection, number" in the translator comment.

@hebasto
Copy link
Member

hebasto commented Apr 30, 2021

One more opinion:

Removing "Peer" from the "Peer Id" column would allow for more prudent use of space.
Otherwise it should be translatable. A simple "ID" or "id" would be better. I think all caps "ID" is better imo.

@hebasto
Copy link
Member

hebasto commented Apr 30, 2021

Is there a way to tell translators synonyms? "Connection" might be easier to translate.

Yes, could mention synonyms like "connection, number" in the translator comment.

We could mention the meaning of a term :)

@hebasto
Copy link
Member

hebasto commented Apr 30, 2021

Heh, interesting. Should I mention "ID" in a translation comment? (I'm not against using "ID" instead if reviewers prefer but to my mind it reminds me of "papers, please" police_officer)

If we concern brevity, that the "Peer" word is redundant because the tab is called "Peers".
If we concern consistency, the getpeerinfo output has the id field.

Anyway, translator comments are always welcome.

IIRC, there were some comments about aligning of the "Peer Id" column in this repo, especially when numbers of id go up. But I cannot find them :(

Maybe our fellow designers @Bosch-0 and @GBKS could share their opinions about this PR?

@jonatack
Copy link
Member Author

-netinfo also uses "id", but ISTM the command line / JSON-RPC interface follows a different paradigm than the GUI:

  • JSON lowercase or snakecase / Capitalized Titles
  • language for developers / language for laypeople
  • brevity / full words
  • untranslated / translated

As for data alignment in the column, note that I discussed what I tried and found in the PR description.

@jonatack
Copy link
Member Author

jonatack commented Apr 30, 2021

It looks like "peers" and "peer" are already translated in qt/locale (if I understand them correctly) in a number of places; here are just a few of them:

    <message>
        <source>&amp;Peers</source>
        <translation>&amp;Gegenstellen</translation>
    </message>
    <message>
        <source>Banned peers</source>
        <translation>Gesperrte Gegenstellen</translation>
    </message>
    <message>
        <source>Select a peer to view detailed information.</source>
        <translation>Gegenstelle auswählen, um detaillierte Informationen zu erhalten.</translation>
    </message>
    <message>
        <source>&amp;Peers</source>
        <translation>&amp;Пиры</translation>
    </message>
    <message>
        <source>Banned peers</source>
        <translation>Заблокированные пиры</translation>
    </message>
    <message>
        <source>Select a peer to view detailed information.</source>
        <translation>Выберите пира для просмотра детальной информации.</translation>
    </message>

@jonatack
Copy link
Member Author

I've decided to close this.

@jonatack jonatack closed this Apr 30, 2021
@jonatack jonatack deleted the peer-id-improvements branch April 30, 2021 20:26
@jonatack
Copy link
Member Author

jonatack commented May 1, 2021

Maybe our fellow designers @Bosch-0 and @GBKS could share their opinions about this PR?

One thought: designer, UI, and UX can be different specialties, a bit like front end / back end / dev ops / DBA / pentest / embedded, etc. There are designers (say, of icons, logos, typography or illustrations) who wouldn't expect to be asked to make a call about a UI question, and others who might be more comfortable with that.

@jonatack
Copy link
Member Author

jonatack commented May 1, 2021

To clarify, I think this is a good change but it's too much time involved on a very tiny change that may never be merged in a repo that isn't my main focus. That said, I'd be happy for someone more focused on the GUI to fix it.

@jarolrod
Copy link
Member

@hebasto This is no longer up for grabs as the idea of changing Peer id to Peer was picked up in #311 and the idea of improving the alignment of the Peer Number was picked up in #325

hebasto added a commit to bitcoin/bitcoin that referenced this pull request May 26, 2021
657b33e qt: add translator comments for peers table columns (Jarol Rodriguez)
73a91c6 gui: rename "Peer Id" to "Peer" in tab column and details area (Jon Atack)

Pull request description:

  Picking up bitcoin-core/gui#290

  **Original PR Description:**
  - renames the peers tab column header from `Peer Id` to `Peer` to allow resizing the column more tightly (this will be particularly useful after #256) and does the same for the peer details area.

  While here, we also add Qt translator comments for the Peer Table columns.

  | Master        | PR               |
  | ----------- | ----------- |
  | ![Screen Shot 2021-05-03 at 1 23 05 AM](https://user-images.githubusercontent.com/23396902/116843818-20a14b00-abaf-11eb-913e-ddff11cda5cd.png) | ![Screen Shot 2021-05-05 at 4 08 45 AM](https://user-images.githubusercontent.com/23396902/117112825-a2cc7380-ad57-11eb-939b-1aceb4214ad1.png) |

ACKs for top commit:
  jonatack:
    utACK 657b33e
  hebasto:
    re-ACK 657b33e

Tree-SHA512: f50116f7ca8719cadf1f95f45e3594b3b92bde9c43eb954f3e963ed10629dd9406efdb5e96aa1f750a926e24a96321d824ed3780bd9cd748774e0b85fd0c9535
@hebasto hebasto added UI All about "look and feel" and removed Design labels May 26, 2021
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request May 27, 2021
657b33e qt: add translator comments for peers table columns (Jarol Rodriguez)
73a91c6 gui: rename "Peer Id" to "Peer" in tab column and details area (Jon Atack)

Pull request description:

  Picking up bitcoin-core/gui#290

  **Original PR Description:**
  - renames the peers tab column header from `Peer Id` to `Peer` to allow resizing the column more tightly (this will be particularly useful after #256) and does the same for the peer details area.

  While here, we also add Qt translator comments for the Peer Table columns.

  | Master        | PR               |
  | ----------- | ----------- |
  | ![Screen Shot 2021-05-03 at 1 23 05 AM](https://user-images.githubusercontent.com/23396902/116843818-20a14b00-abaf-11eb-913e-ddff11cda5cd.png) | ![Screen Shot 2021-05-05 at 4 08 45 AM](https://user-images.githubusercontent.com/23396902/117112825-a2cc7380-ad57-11eb-939b-1aceb4214ad1.png) |

ACKs for top commit:
  jonatack:
    utACK 657b33e
  hebasto:
    re-ACK 657b33e

Tree-SHA512: f50116f7ca8719cadf1f95f45e3594b3b92bde9c43eb954f3e963ed10629dd9406efdb5e96aa1f750a926e24a96321d824ed3780bd9cd748774e0b85fd0c9535
@bitcoin-core bitcoin-core locked as resolved and limited conversation to collaborators Aug 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
UI All about "look and feel"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants