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 680606 - Required to review AtkObject properties documentation
Required to review AtkObject properties documentation
Status: RESOLVED OBSOLETE
Product: atk
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: ATK maintainer(s)
ATK maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2012-07-25 17:03 UTC by Alejandro Piñeiro Iglesias (IRC: infapi00)
Modified: 2021-06-10 11:26 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Alejandro Piñeiro Iglesias (IRC: infapi00) 2012-07-25 17:03:27 UTC
This mail
https://mail.gnome.org/archives/gnome-accessibility-list/2012-July/msg00016.html

point to one specific problem related to descriptions like "used to notify...". I agree that having just that is not a good documentation. Each property documentation should describe what that property is, and then, if it makes sense, explain their usage.

After that mail I found more issues:

 * At accessible-table-caption: "this property should not be used. accessible-table-caption-object should be used instead." This should the usual GNOME documentation convention of "X is deprecated, use Y instead"
 * In general I think that most table related properties on AtkObject are not used at all, and should be deprecated in favour of usage of AtkTable methods
 * That could also applies to other properties like "accessible-hypertext-nlinks"

In general the documentation of all AtkObject properties should be reviewed.
Comment 1 André Klapper 2021-06-10 11:26:21 UTC
GNOME is going to shut down bugzilla.gnome.org in favor of gitlab.gnome.org.
As part of that, we are mass-closing older open tickets in bugzilla.gnome.org
which have not seen updates for a longer time (resources are unfortunately
quite limited so not every ticket can get handled).

If you can still reproduce the situation described in this ticket in a recent
and supported software version of atk, then please follow
  https://wiki.gnome.org/GettingInTouch/BugReportingGuidelines
and create a ticket at
  https://gitlab.gnome.org/GNOME/atk/-/issues/

Thank you for your understanding and your help.