summaryrefslogtreecommitdiff
path: root/autodoc.pl
diff options
context:
space:
mode:
authorDavid Mitchell <davem@iabyn.com>2010-08-25 13:10:45 +0100
committerDavid Mitchell <davem@iabyn.com>2010-08-25 13:10:45 +0100
commit474d0ac875c37fee4bab4978192a9bf358bd4eeb (patch)
treeae8645f6540dbabae99c2b9afd1ace097202e64e /autodoc.pl
parentcf5f2f8f537538393a9a32ef490e2894fe5032e0 (diff)
downloadperl-474d0ac875c37fee4bab4978192a9bf358bd4eeb.tar.gz
perlpod.api: improve the prose
Tweak the text of the previous commit that describes the status of undocumented functions in the public API.
Diffstat (limited to 'autodoc.pl')
-rw-r--r--autodoc.pl12
1 files changed, 7 insertions, 5 deletions
diff --git a/autodoc.pl b/autodoc.pl
index 2e5217e92b..c271bf434d 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -184,11 +184,13 @@ _EOH_
if (@$missing) {
print $fh "\n=head1 Undocumented functions\n\n";
print $fh <<'_EOB_';
-Some functions are currently undocumented; use at your own risk, as the
-interfaces are subject to change. If you use one of these, do everyone a
-favor by creating documentation for it. The acceptance of your patch will
-indicate that the interface is stable (unless it is explicitly marked
-otherwise). The undocumented functions are:
+The following functions have been flagged as part of the public API,
+but are currently undocumented. Use them at your own risk, as the
+interfaces are subject to change.
+
+If you use one of them, you may wish to consider creating and submitting
+documentation for it. If your patch is accepted, this will indicate that
+the interface is stable (unless it is explicitly marked otherwise).
=over