After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 791020 - Remove the description-list association from docs for ATK_ROLE_DESCRIPTION_{TERM,VALUE}
Remove the description-list association from docs for ATK_ROLE_DESCRIPTION_{T...
Status: RESOLVED FIXED
Product: atk
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Joanmarie Diggs (IRC: joanie)
ATK maintainer(s)
Depends on:
Blocks: 791021
 
 
Reported: 2017-11-30 12:10 UTC by Joanmarie Diggs (IRC: joanie)
Modified: 2017-11-30 14:12 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
proposed patch (1.88 KB, patch)
2017-11-30 12:22 UTC, Joanmarie Diggs (IRC: joanie)
committed Details | Review

Description Joanmarie Diggs (IRC: joanie) 2017-11-30 12:10:38 UTC
We currently have three roles related to term-value pairs:
* ATK_ROLE_DESCRIPTION_LIST
* ATK_ROLE_DESCRIPTION_TERM
* ATK_ROLE_DESCRIPTION_VALUE

Because the documentation for latter two explicitly states that they are "in a description list," there is some hesitancy to use these roles for terms and/or values which are not within a list. We have two choices:

1) Create more roles
2) Remove the description-list association for the latter two's docs

I personally don't see that we need yet another role. And we can keep the current docs for ATK_ROLE_DESCRIPTION_LIST. In other words, an ATK_ROLE_DESCRIPTION_LIST should contain ATK_ROLE_DESCRIPTION_TERM and ATK_ROLE_DESCRIPTION_VALUE objects. It's simply not a requirement for ATK_ROLE_DESCRIPTION_{TERM,VALUE} to exist within a list.
Comment 1 Joanmarie Diggs (IRC: joanie) 2017-11-30 12:22:27 UTC
Created attachment 364664 [details] [review]
proposed patch
Comment 2 Alejandro Piñeiro Iglesias (IRC: infapi00) 2017-11-30 13:39:46 UTC
Review of attachment 364664 [details] [review]:

Makes sense, and in general, I'm in favor to avoid adding more roles to the already long list of roles if possible.
Comment 3 Joanmarie Diggs (IRC: joanie) 2017-11-30 13:55:14 UTC
Comment on attachment 364664 [details] [review]
proposed patch

Thanks for the review!

Commit: https://git.gnome.org/browse/atk/commit/?id=4a2632d