The UI isn't very uniform. On the one hand we have the following relationship labels:

"Comment: Node ID"
"Comment: Parent CID"
"Comment: User ID"

But on the other hand we also have labels without an "ID" suffix:

"Book: Parent"
"Book: Top level book"
"Node revision: User"
"Access log: User"
"Upload: Node"
"Node: Attached files"

Perhaps we should decide on one style.

The "ID" suffixes are all on Comment relationships, so I'd say it's a "documentation bug" and remove these "ID"s. The attached patch does this.

This issue seems unimportant, I know. I'm a co-maintainer of some module and I was thinking about renaming a "User ID" relationship we provide to "User", because it seems more correct and understandable without the "ID"; However, users are going to get accustomed to seeing the Comment relationships style and might expect this "ID".

(While working on the patch I saw the Book module is missing periods at ends of "sentences", so I added these as well, though there are still missing periods in other "modules", but I didn't want to touch those as these ungrammatical periods do look somewhat out of place...)

CommentFileSizeAuthor
ui_id_suffix.diff2.65 KBmooffie
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

merlinofchaos’s picture

Status: Needs review » Reviewed & tested by the community

Geez, I thought we'd gotten all the missing periods. So difficult to find.

I think I agree that specifying the ID in a relationship is not intuitive to the user.

mooffie’s picture

I think I agree that specifying the ID in a relationship is not intuitive to the user

The "ID", in the user interface, isn't only unintuitive: it's incorrect. That's because the purpose of a relationship, at least from the user perspective, is to bring in some entity. It's not a numerical ID that it brings in, but an entity.

mooffie’s picture

The "ID", in the user interface, isn't only unintuitive: it's incorrect.

Hm. I should really try to express myself more humbly ;-)

A good excuse for the correctness of having an "ID" there of course can be found. All in all, I feel it's more correct not to have it there.

merlinofchaos’s picture

Status: Reviewed & tested by the community » Fixed

Committed. Thanks!

Anonymous’s picture

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.