search

eserte / perl-tk

the perl module Tk
https://metacpan.org/release/Tk
Other
44 stars 31 forks source link

fixed link to getOpenFile #19

Closed asb-capfan closed 4 years ago

asb-capfan commented 8 years ago

The link to getOpenFile() for the file selection dialog pointed to Tk::getOpenFile. However, you have to search for getOpenFile without the Tk namespace.

eserte commented 8 years ago

Let me see. tkpod does the linking right, while metacpan and search.cpan.org do not. Maybe it's because of another reason --- I suspect that the other Pod processors cannot cope with the NAME value of getOpenFile.pod which is a comma-separated list: "Tk::getOpenFile, Tk::getSaveFile"

asb-capfan commented 8 years ago

Would it make sense to split getOpenFile and getSaveFile?

eserte commented 8 years ago

The both have a lot of common documentation. I would not like to duplicate this.

Maybe it would work if the NAME section had two lines:

Tk::getOpenFile - pop up a dialog box for the user to select a file to open.

Tk::getSaveFile - pop up a dialog box for the user to select a file to save.

Also not nice, but maybe this could work for metacpan + search.cpan.org?

chrstphrchvz commented 6 years ago

I'm not familiar with POD, but might it be appropriate to use something like Pod::Weaver so that either both modules can "include" their documentation from a common file, or one package borrows from the other's?

eserte commented 4 years ago

Current solution seems to work --- https://metacpan.org/pod/release/SREZIC/Tk-804.034_500/pod/FileSelect.pod links to Tk::getOpenFile and there's a stub documentation for Tk::getSaveFile, referring to Tk::getOpenFile.