tracker issue : CF-3335948

select a category, or use search below
(searches all categories and all time range)
Title:

[ANeff] Doc Bug for: Many array function docs have typos and are unclear and misleading

| View in Tracker

Status/Resolution/Reason: Closed/Fixed/

Reporter/Name(from Bugbase): Aaron Neff / Aaron Neff (Aaron Neff)

Created: 09/24/2012

Components: Documentation

Versions: 10.0

Failure Type: Unspecified

Found In Build/Fixed In Build: Final /

Priority/Frequency: Trivial / Some users will encounter

Locale/System: English / Platforms All

Vote Count: 0

Listed in the version 2016.0.0.297996 Issues Fixed doc
Verification notes: verified_partially_fixed on June 20, 2018 using build 2016.0.01.298513 
Many array function docs have typos and are unclear and misleading.

ArrayFind:
- "Description" section is unclear and misleading
- "Returns" section has an extra comma
- "Syntax" section is incomplete and does not match the "Parameters"
- "Parameters" section is incomplete and could use better descriptions
- "Example" section could be improved

ArrayFindNoCase:
- "Description" section is unclear and misleading
- "Returns" section has an extra comma
- "Syntax" section is incomplete and does not match the "Parameters"
- "Parameters" section is incomplete and could use better descriptions
- "Example" section could be improved

ArrayFindAll:
- "Description" section is unclear and misleading
- "Returns" section is unclear b/c it does not indicate return type is array
- "Syntax" section is incomplete and does not match the "Parameters"
- "Parameters" section is incomplete and could use better descriptions
- "Example" section is missing

ArrayFindAllNoCase:
- "Description" section is unclear and misleading
- "Returns" section is unclear b/c it does not indicate return type is array
- "Syntax" section is incomplete and does not match the "Parameters"
- "Parameters" section is incomplete and could use better descriptions
- "Example" section is missing

ArrayContains:
- "Description" section is unclear b/c it lacks the word "for" in two places
- "Syntax" section has an unnecessary pound sign (#)
- "Parameters" section could use better descriptions
- "Example" section is too verbose

ArrayContainsNoCase:
- This case-insensitive version of ArrayContains is missing from the language
- I've included documentation info for this function

ArrayDelete:
- "Description" section is unclear and misleading
- "Parameters" section could use better descriptions
- "Example" section is too verbose

ArrayDeleteNoCase:
- This case-insensitive version of ArrayDelete is missing from the language
- I've included documentation info for this function

I've attached suggested changes. In the case of ArrayFind/ArrayFindNoCase/ArrayFindAll/ArrayFindAllNoCAse, the documentation is unclear that the case-sensitive/case-insensitive only applies when the second parameter is a simple string object. In the case of "ArrayDelete", the documentation does not clarify that only the first match is deleted and that it is case-sensitive. In the case of the "Parameters" section, the "array" and "object" do NOT have to be the _"name"_ of the array or object.

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3335948

External Customer Info:
External Company:  
External Customer Name: itisdesign
External Customer Email:

Attachments:

  1. September 25, 2012 00:00:00: 1_20120924_ArrayFunctionDocsSuggestedChanges.txt

Comments:

Updated all the Array functions. Also, added the 2 missing functions. Please verify the changes for searching for the function at: https://learn.adobe.com/wiki/display/coldfusionen
Comment by Frank J.
17987 | February 02, 2014 11:13:57 PM GMT
Fuction ArrayContainsNoCase is not added in english documentation. Please check.
Comment by Poonam J.
17988 | June 15, 2015 11:20:45 PM GMT
Updated: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/arraycontainsnocase.html
Comment by Jacob J.
17989 | September 28, 2015 08:27:50 AM GMT
Hi Frank, Poonam and Jacob, 2 items were not done: ArrayFindNoCase: - "Syntax" section is incomplete and does not match the "Parameters" TODO: Add this to Syntax: ArrayFindNoCase(array, function(arrayElement) {return true|false;}) ArrayFindAllNoCase: - "Syntax" section is incomplete and does not match the "Parameters" TODO: Add this to Syntax: ArrayFindAllNoCase(array, function(arrayElement) {return true|false;}) Thanks!, -Aaron
Comment by External U.
17990 | September 28, 2015 11:39:17 PM GMT
Hi Adobe, I've verified this is mostly fixed in CF2016 Update 1 (build 2016.0.01.298513). Thanks!, -Aaron
Comment by Aaron N.
29098 | June 20, 2018 07:06:40 AM GMT