From 1fc4ce3715524ca2d6231b9c0ebec64b8ca09c0e Mon Sep 17 00:00:00 2001 From: John Kerl Date: Wed, 26 Oct 2016 19:02:06 -0400 Subject: [PATCH] doc neaten --- doc/content-for-reference.html | 7 +++- doc/cookbook.html | 70 +++++++++++++++++----------------- doc/reference.html | 11 +++--- 3 files changed, 47 insertions(+), 41 deletions(-) diff --git a/doc/content-for-reference.html b/doc/content-for-reference.html index c00cf9844..cd21505fc 100644 --- a/doc/content-for-reference.html +++ b/doc/content-for-reference.html @@ -1698,11 +1698,16 @@ recursive or mutually recursive. Functions may not call subroutines.
  • Functions have read access to $-variables and @-variables but may not modify them. +See also + +this cookbook item for an example.
  • Argument values may be reassigned: they are not read-only.
  • When a return value is not implicitly returned, this results in a return -value of absent-null. See also the section on +value of absent-null. (In the example above, if there were records for which +the argument to f is non-numeric, the assignments would be skipped.) +See also the section on empty_and_absent null data.
  • See the section on local variables for diff --git a/doc/cookbook.html b/doc/cookbook.html index 1643bc576..c3199a8fc 100644 --- a/doc/cookbook.html +++ b/doc/cookbook.html @@ -605,33 +605,33 @@ $ mlr --ofmt '%.9lf' --opprint seqgen --start 1 --stop 28 then put ' ' then put '$seconds=systime()' then step -a delta -f seconds then cut -x -f seconds i o fcount seconds_delta 1 1 1 0 -2 2 3 0.000021935 -3 3 5 0.000012159 -4 5 9 0.000013828 -5 8 15 0.000018120 -6 13 25 0.000025988 -7 21 41 0.000040054 +2 2 3 0.000022173 +3 3 5 0.000012875 +4 5 9 0.000014067 +5 8 15 0.000017881 +6 13 25 0.000027180 +7 21 41 0.000038862 8 34 67 0.000061035 -9 55 109 0.000094891 -10 89 177 0.000148058 -11 144 287 0.000234842 -12 233 465 0.000380039 -13 377 753 0.000602961 -14 610 1219 0.000971079 -15 987 1973 0.001572132 -16 1597 3193 0.002545834 -17 2584 5167 0.004101038 -18 4181 8361 0.006519079 -19 6765 13529 0.010349035 -20 10946 21891 0.016438961 -21 17711 35421 0.026494026 -22 28657 57313 0.042817831 -23 46368 92735 0.073794127 -24 75025 150049 0.117750883 -25 121393 242785 0.187194109 -26 196418 392835 0.296587944 -27 317811 635621 0.468843937 -28 514229 1028457 0.734012127 +9 55 109 0.000095129 +10 89 177 0.000147820 +11 144 287 0.000234127 +12 233 465 0.000375032 +13 377 753 0.000600815 +14 610 1219 0.000970125 +15 987 1973 0.001564026 +16 1597 3193 0.002518892 +17 2584 5167 0.004086018 +18 4181 8361 0.006515980 +19 6765 13529 0.010169029 +20 10946 21891 0.017036915 +21 17711 35421 0.031524181 +22 28657 57313 0.047505856 +23 46368 92735 0.073539019 +24 75025 150049 0.112071037 +25 121393 242785 0.187931061 +26 196418 392835 0.311629057 +27 317811 635621 0.488912821 +28 514229 1028457 0.764958143

    @@ -663,18 +663,18 @@ $ mlr --ofmt '%.9lf' --opprint seqgen --start 1 --stop 28 then put ' ' then put '$seconds=systime()' then step -a delta -f seconds then cut -x -f seconds i o fcount seconds_delta 1 1 1 0 -2 2 3 0.000024080 -3 3 3 0.000012875 +2 2 3 0.000023842 +3 3 3 0.000014067 4 5 3 0.000010967 -5 8 3 0.000011206 -6 13 3 0.000009775 -7 21 3 0.000010014 +5 8 3 0.000010967 +6 13 3 0.000010014 +7 21 3 0.000009060 8 34 3 0.000010014 -9 55 3 0.000009060 -10 89 3 0.000010014 +9 55 3 0.000010014 +10 89 3 0.000009060 11 144 3 0.000009060 -12 233 3 0.000012875 -13 377 3 0.000010967 +12 233 3 0.000013828 +13 377 3 0.000010014 14 610 3 0.000010014 15 987 3 0.000010014 16 1597 3 0.000010014 diff --git a/doc/reference.html b/doc/reference.html index 36b40792e..9e76a4e0f 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -6665,17 +6665,18 @@ recursive or mutually recursive. Functions may not call subroutines.

  • Functions have read access to $-variables and @-variables but may not modify them. +See also + +this cookbook item for an example.
  • Argument values may be reassigned: they are not read-only.
  • When a return value is not implicitly returned, this results in a return -value of absent-null. See also the section on +value of absent-null. (In the example above, if there were records for which +the argument to f is non-numeric, the assignments would be skipped.) +See also the section on empty_and_absent null data. -

    xxx example code here - -

  • xxx missing return leads to absent-null (which xref). return value (single). -
  • See the section on local variables for information on scope and extent of arguments, as well as for information on the use of local variables within functions.