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 784483 - Improve documentation of Gdk::RGBA(Glib::ustring const&)
Improve documentation of Gdk::RGBA(Glib::ustring const&)
Status: RESOLVED FIXED
Product: gtkmm
Classification: Bindings
Component: gdkmm
3.22.x
Other All
: Normal normal
: ---
Assigned To: gtkmm-forge
gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2017-07-03 18:15 UTC by Daniel Boles
Modified: 2017-07-06 12:56 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Gdk::RGBA: Update ctor(ustring) docs from GTK+ (1.85 KB, patch)
2017-07-03 18:16 UTC, Daniel Boles
committed Details | Review

Description Daniel Boles 2017-07-03 18:15:37 UTC
The docs in gtkmm are manually written and either miss or get wrong some details:
 * They talk about hex colours without the required # prefix
 * They don't mention the rgb[a]() syntax

This patch replaces these with an adaptation of the docs from GTK+ upstream, amended for wording, formatting, and a couple of tweaks to grammar.
Comment 1 Daniel Boles 2017-07-03 18:16:06 UTC
Created attachment 354850 [details] [review]
Gdk::RGBA: Update ctor(ustring) docs from GTK+
Comment 2 Kjell Ahlstedt 2017-07-05 15:25:11 UTC
Looks fine. Just a minor comment: A suppose that "precentage" is a typo,
copied too verbatim from the documentation of gdk_rgba_parse().
This is the kind of patch that you can push to any git branch you want.

I wonder if you really have to file bug reports for such obvious and harmless
improvements as this one. Perhaps you can push them to the git repository
without asking. I leave it to Murray to decide.
Comment 3 Daniel Boles 2017-07-05 15:31:01 UTC
(In reply to Kjell Ahlstedt from comment #2)
> Just a minor comment: A suppose that "precentage" is a typo,
> copied too verbatim from the documentation of gdk_rgba_parse().

Indeed, I didn't notice that one. Thanks!


> This is the kind of patch that you can push to any git branch you want.

Great, will do so later.
 

> I wonder if you really have to file bug reports for such obvious and harmless
> improvements as this one. Perhaps you can push them to the git repository
> without asking. I leave it to Murray to decide.

I do try to avoid spamming tickets if the patch is blatantly correct. In this case, I thought it was best to double-check, mainly because I'm not certain of all the syntax used in the docs, and I didn't have much time then to find something to compare against, so I wanted to be sure I had formatted everything correctly.
Comment 4 Murray Cumming 2017-07-06 11:25:08 UTC
> I leave it to Murray to decide.

Yes, documentation improvements are quite risk-free and we can always check after it has been pushed.

But it's also nice if we can help Daniel first if he feels he need it.

Thanks.
Comment 5 Daniel Boles 2017-07-06 12:56:29 UTC
Comment on attachment 354850 [details] [review]
Gdk::RGBA: Update ctor(ustring) docs from GTK+

committed with the spelling fix, which I'll now amend in GTK+ too