GNOME Bugzilla – Bug 784483
Improve documentation of Gdk::RGBA(Glib::ustring const&)
Last modified: 2017-07-06 12:56:50 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.
Created attachment 354850 [details] [review] Gdk::RGBA: Update ctor(ustring) docs from GTK+
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.
(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.
> 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 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