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 753466 - [patch] Add missing information to POD
[patch] Add missing information to POD
Status: RESOLVED FIXED
Product: gnome-perl
Classification: Bindings
Component: Glib
unspecified
Other All
: Normal normal
: ---
Assigned To: gtk2-perl-bugs
gtk2-perl-bugs
Depends on:
Blocks:
 
 
Reported: 2015-08-10 13:29 UTC by intrigeri
Modified: 2016-09-20 13:23 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Add missing information to POD (3.64 KB, patch)
2015-08-18 08:15 UTC, intrigeri 		committed Details | Review

Description intrigeri 2015-08-10 13:29:19 UTC 
Hi,

we've been applying https://anonscm.debian.org/cgit/pkg-perl/packages/libglib-perl.git/tree/debian/patches/Add-missing-information-to-POD.patch for many years now in Debian. Sorry for not forwarding it upstream earlier, I'm currently in the process of fixing this for all our perl-Glib patches.

Please consider applying this patch upstream.

Cheers!
Comment 1 Emmanuele Bassi (:ebassi) 2015-08-10 13:31:23 UTC 
Could you please attach the patch to this bug, so that it can be reviewed and easily applied?

Thanks!
Comment 2 intrigeri 2015-08-18 08:15:32 UTC 
Created attachment 309442 [details] [review]
Add missing information to POD
Comment 3 Torsten Schoenfeld 2015-12-06 13:35:37 UTC 
It seems like the patch also adds summary lines for a few namespaces
that don't have associated POD yet: Glib::Param::Boolean,
Glib::Param::String and Glib::Param::Unichar.  Are these summary lines
necessary?
Comment 4 intrigeri 2015-12-29 18:24:31 UTC 
(In reply to Torsten Schoenfeld from comment #3)
> It seems like the patch also adds summary lines for a few namespaces
> that don't have associated POD yet: Glib::Param::Boolean,
> Glib::Param::String and Glib::Param::Unichar.  Are these summary lines
> necessary?

Now that our patch for https://bugzilla.gnome.org/show_bug.cgi?id=753468 has been applied, even these namespaces can have some (extremely minimal) auto-generated documentation, such as:

NAME
       Glib::Param::String -  Wrapper for string parameters in GLib

HIERARCHY
         Glib::ParamSpec
         +----Glib::Param::String

SEE ALSO
       Glib, Glib::ParamSpec

Without the patch proposed here, we have no such documentation for those namespaces. With the patch, we have it.

It seems worth it to me, but you're the maintainer, so I'm sure you have a better overview of the problem and then it's your call: if you prefer I can resubmit a patch that does not include those specific changes.
Comment 5 Torsten Schoenfeld 2016-09-20 13:23:12 UTC 
Alright, convinced.  Committed with slight modifications.  Thanks for the patch.