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 791021 - Remove the description-list association from docs for ATSPI_ROLE_DESCRIPTION_{TERM,VALUE}
Remove the description-list association from docs for ATSPI_ROLE_DESCRIPTION_...
Status: RESOLVED FIXED
Product: at-spi
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Joanmarie Diggs (IRC: joanie)
At-spi maintainer(s)
Depends on: 791020
Blocks:
 
 
Reported: 2017-11-30 12:30 UTC by Joanmarie Diggs (IRC: joanie)
Modified: 2017-11-30 14:30 UTC
See Also:
GNOME target: ---
GNOME version: ---


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

Description Joanmarie Diggs (IRC: joanie) 2017-11-30 12:30:21 UTC
+++ This bug was initially created as a clone of Bug #791020 +++

We currently have three roles related to term-value pairs:
* ATSPI_ROLE_DESCRIPTION_LIST
* ATSPI_ROLE_DESCRIPTION_TERM
* ATSPI_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 ATSPI_ROLE_DESCRIPTION_LIST. In other words, an ATSPI_ROLE_DESCRIPTION_LIST should contain ATSPI_ROLE_DESCRIPTION_TERM and ATSPI_ROLE_DESCRIPTION_VALUE objects. It's simply not a requirement for ATSPI_ROLE_DESCRIPTION_{TERM,VALUE} to exist within a list.
Comment 1 Joanmarie Diggs (IRC: joanie) 2017-11-30 12:33:00 UTC
Created attachment 364666 [details] [review]
proposed patch
Comment 2 Mike Gorse 2017-11-30 14:29:42 UTC
Comment on attachment 364666 [details] [review]
proposed patch

Fixed a small typo and pushed to master: 319c64