develooper Front page | perl.perl5.porters | Postings from August 2016

Re: Internals:: undocumented

Thread Previous | Thread Next
August 7, 2016 10:25
Re: Internals:: undocumented
Message ID:
On 7 Aug 2016 11:34, "Sawyer X" <> wrote:
> On 08/06/2016 03:39 PM, Tony Cook wrote:
> > On Sat, Aug 06, 2016 at 09:05:23AM -0400, James E Keenan wrote:
> >> What is Internals?
> > Internals is deliberately undocumented, unsupported.
> Not documenting as a form of keeping possible users away feels like
> security by obscurity. Documentation should not imply support. We can
> document it clearly for other core developers and note *very* clearly
> that it is unsupported.

I don't agree. We document indirectly those functions that are intended to
be user serviceable. The rest imo should not be documented because they
should not exist but do because they are needed to test perl. Furthermore
they are typically documented at the XS or perl internals level,  and all
the perl level functions do is expose internals routines.

I also think that if we are going to document them we should move them to
better namespace.


Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About