On Sun, Dec 07, 2003 at 05:10:44PM -0800, Michael G Schwern wrote: > On Sun, Dec 07, 2003 at 04:11:54PM -0800, Daniel Macks wrote: > > Doc fix: forgot that '=begin private' POD doesn't display. > > Finished my diatrabe against the prompt_selection API. > > If its private, you should probably rename it _read_properties_lines(). > This is much more obvious than saying its private in the docs. You can't > not read the function name. > > Also, its been my opinion that the docs for private functions *shouldn't* > display in perldoc to prevent user temptation. The only people who need to > see it are those who are working on the Fink::Services code so they'll > see the docs when they look at the code.
I agree. I think calling it a "private function" is a bit too strong here. There's no real reason why these functions aren't in @EXPORT_OK, it's just that there are more convenient wrappers that massage several different kinds of data fink has into a common format for the actual handling. And they merely pass through some of their parameters. The docs for these wrapper functions' parameters are thus "whatever the underlying function says they are", so that's how I documented them. Which meant the underlying private function docs needed to be exposed. I could copy the private-function description into each of the public-function descriptions, but that doesn't seem right. dan -- Daniel Macks [EMAIL PROTECTED] http://www.netspace.org/~dmacks ------------------------------------------------------- This SF.net email is sponsored by: SF.net Giveback Program. Does SourceForge.net help you be more productive? Does it help you create better code? SHARE THE LOVE, and help us help YOU! Click Here: http://sourceforge.net/donate/ _______________________________________________ Fink-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/fink-devel
