Re: [Jgeneral] NuVoc wordings

[chris burke]

I am opposed to this for several reasons, e.g.

I disagree that verb descriptions suggest that results will somehow
replace the values being operated on.

Experienced users don't think this way, and beginners will quickly follow suit.

It makes any explanations longer. We expect users to understand J
syntax without constant reminder of it.

By starting with "takes a copy of" this suggests that something
unusual is being done. So the natural question would then be what if I
don't want to "take a copy of".

On Wed, Jun 8, 2022 at 9:14 PM Arthur Anger  wrote:
>
> All--
> Each non-assigment step in a computation produces copies(!) of its inputs, 
> selected and arranged in various specified ways, awaiting disposition--in 
> another step, in assignment to storage, in output, or in discard.
>
> At the very least, any recipe for processing an array should begin with some 
> version of "Take a copy of y, then...", and consistently refer to that copy, 
> rather than to y.
>
> As an example, the page for Nub currently contains the following statements:
>   Removes duplicates from a list 
> .
>
>   More generally, removes any item 
>  of an array 
>  that matches a 
> preceding item.
>
>   1. Remove duplicate values 
>  from a lis 
> t
>
>   2. Remove duplicate rows from a table 
> 
> I recommend replacing them with:
>   Copies items from a list, omitting duplicates.
>   More generally, omits any item 
>  of an array 
>  that matches a 
> preceding item.
>   1. Omit duplicate values 
>  from a lis 
> t
>   2. Omit duplicate rows from a table 
> 
>
> The language used to describe a verb often suggests that its result will 
> somehow replace the values being operated on, which will be (nearly) accurate 
> only if followed immediately by re-assignment to the same, named, argument.
>
> I urge that any new documentation observe this distinction, and that any 
> definition being updated follow this pattern.  If there is a consensus that 
> this is a worthy cause, I shall be willing to propose such changes where I 
> may encounter them in coming months.
> --Art
>
>
>
> --
> For information about J forums see http://www.jsoftware.com/forums.htm
--
For information about J forums see http://www.jsoftware.com/forums.htm

[Jgeneral] NuVoc wordings

[Arthur Anger]

All--
Each non-assigment step in a computation produces copies(!) of its inputs, 
selected and arranged in various specified ways, awaiting disposition--in 
another step, in assignment to storage, in output, or in discard.

At the very least, any recipe for processing an array should begin with some 
version of "Take a copy of y, then...", and consistently refer to that copy, 
rather than to y.

As an example, the page for Nub currently contains the following statements:
  Removes duplicates from a list 
.

  More generally, removes any item 
 of an array 
 that matches a preceding 
item.

  1. Remove duplicate values 
 from a lis 
t

  2. Remove duplicate rows from a table 

I recommend replacing them with:
  Copies items from a list, omitting duplicates.
  More generally, omits any item 
 of an array 
 that matches a preceding 
item.
  1. Omit duplicate values 
 from a lis 
t
  2. Omit duplicate rows from a table 


The language used to describe a verb often suggests that its result will 
somehow replace the values being operated on, which will be (nearly) accurate 
only if followed immediately by re-assignment to the same, named, argument.

I urge that any new documentation observe this distinction, and that any 
definition being updated follow this pattern.  If there is a consensus that 
this is a worthy cause, I shall be willing to propose such changes where I may 
encounter them in coming months.
--Art



--
For information about J forums see http://www.jsoftware.com/forums.htm