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 760238 - Improve function documentation for gtk_css_provider_load_from_data()
Improve function documentation for gtk_css_provider_load_from_data()
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
3.19.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2016-01-06 20:41 UTC by Eric Williams
Modified: 2016-01-16 00:24 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Improved function doc for gtk_css_provider_load_from_data() (909 bytes, patch)
2016-01-06 20:41 UTC, Eric Williams
none Details | Review
Typo fix for original patch (927 bytes, patch)
2016-01-13 13:33 UTC, Eric Williams
none Details | Review

Description Eric Williams 2016-01-06 20:41:10 UTC
Created attachment 318383 [details] [review]
Improved function doc for gtk_css_provider_load_from_data()

I noticed the function doc for gtk_css_provider_load_from_data() was a bit vague, as it states:

"Loads data into css_provider, making it clear any previously loaded information."

I confirmed on IRC that this function actually clears any previously loaded information, so I propose to change the docs something a bit clearer:

"Loads data into css_provider, and by doing do clears any previously loaded
information."

I've attached the proposed patch.
Comment 1 Matthias Clasen 2016-01-06 22:23:13 UTC
Review of attachment 318383 [details] [review]:

sure, looks good
Comment 2 Ben 2016-01-10 21:13:44 UTC
do you mean 'by doing so clears'?
Comment 3 Eric Williams 2016-01-11 13:28:55 UTC
(In reply to Ben from comment #2)
> do you mean 'by doing so clears'?

The act of calling this function, gtk_css_provider_load_from_data(), clears any previously loaded information for css_provider.
Comment 4 Ben 2016-01-13 00:13:16 UTC
I meant you have a typo - 'by doing so' not 'by doing do'
Comment 5 Eric Williams 2016-01-13 13:33:45 UTC
Created attachment 318954 [details] [review]
Typo fix for original patch

(In reply to Ben from comment #4)
> I meant you have a typo - 'by doing so' not 'by doing do'

Ah, good call! I've uploaded a patch that fixes the typo.
Comment 6 Ben 2016-01-14 22:03:59 UTC
pushed