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 729466 - Improve "Adding Your Custom Widgets" Documentation
Improve "Adding Your Custom Widgets" Documentation
Product: glade
Classification: Applications
Component: documentation
git master
Other Linux
: Normal enhancement
: ---
Assigned To: Glade 3 Maintainers
Glade 3 Maintainers
Depends on:
Reported: 2014-05-03 17:23 UTC by Tristian Celestin
Modified: 2018-03-26 15:36 UTC
See Also:
GNOME target: ---
GNOME version: ---

Improve documentation in catalogintro (80.45 KB, patch)
2014-05-03 17:23 UTC, Tristian Celestin
none Details | Review

Description Tristian Celestin 2014-05-03 17:23:45 UTC
Created attachment 275755 [details] [review]
Improve documentation in catalogintro

The pages under the header "Adding Your Custom Widgets" could use the following improvements:
- Grammar edits to improve clarity: For instance, there are a number of run-on sentences that make parsing the documentation rather difficult.
- Cross references: Instead of mentioning that concepts will be explained in the "next" chapter, link to it.
- Improved cohesiveness: It would have helped my understanding if all the documentation under this header referred to a common widget and walked me through modifying the catalog for this widget.
- Improved example: It also would have also helped my understanding if the example widget were something more conceptually familiar, like a TVChannelWidget, instead of something abstract like a FooFrobnicator.

I've started making changes to the documentation that help meet these goals. Comments are welcome.
Comment 1 GNOME Infrastructure Team 2018-03-26 15:36:13 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: