0000728: efun documentation for filter hard to interpret

ID	Project	Category	View Status	Date Submitted	Last Update

0000728	LDMud	Documentation	public	2010-02-22 19:51	2010-02-22 19:51

Reporter	Wildcat	Assigned To
Priority	normal	Severity	text	Reproducibility	always
Status	new	Resolution	open

Summary	0000728: efun documentation for filter hard to interpret
Description	the first line of the english doc for filter reads: Call the function <ob>-><func>() resp. the closure <cl> for every element of the array, or mapping <arg>, and return a result made from those elements for which the function call returns TRUE. A strict reading of the sentence makes no sense. I believe what it is trying to say is: "Call either the function <ob>-><func>() or the closure <cl> for every element of the array, or mapping <arg>, and return a result made from those elements for which the function call returns TRUE." resp. is probably an abbreviation for respectively but that's not a word that a newly promoted wizard would expect to know in the context given. In addition, that sentence does not address the prototype: mixed * filter (mixed *arg, mapping map, mixed extra...) so the whole thing should probably be rewritten. (This was something that actually came up when a new wizard was trying to learn the Mudlib and when using filter was suggested to him he had difficulty in parsing what the efun actually did based on the man page.)
Tags	No tags attached.

External Data (URL)

Date Modified	Username	Field	Change
2010-02-22 19:51	Wildcat	New Issue