tracker issue : CF-4201164

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

[ANeff] Doc Bug for: Multiple ArrayContainsNoCase issues

| View in Tracker

Status/Resolution/Reason: Closed/Fixed/Fixed

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

Created: 02/14/2018

Components: Documentation

Versions: 2016

Failure Type: Conflict With Docs

Found In Build/Fixed In Build: 0 / latest doc

Priority/Frequency: Normal /

Locale/System: / Platforms All

Vote Count: 0

Verification notes: verified_not_fixed on March 22, 2018 using build 2016.0.05.303689
Issue: Multiple ArrayContainsNoCase issues (and a couple ArrayContains issues)

Steps to Reproduce: Compare the ArrayContains and ArrayContainsNoCase docs

Issue 1: The descriptions should be nearly identical, but aren't.

Suggested ArrayContainsNoCase Description section (same as ArrayContains description, but "case-sensitive" changed to "case-insensitive"):
-----------
Searches an array for the presence of a specified object. The function searches for simple objects such as strings and numbers or for complex objects such as structures. Simple object string searches are case-insensitive. This function does not support searches for COM and CORBA objects.
-----------

Issue 2: The function returns YES/NO but doc says it returns True/False.

Suggested ArrayContainsNoCase Returns section ("True" should be "Yes" [well.. technically "YES", but w/e] to match ArrayContains doc):
-----------
Yes, if the specified object exists in the array.
-----------

Issue 3: Syntax section is borked. It says "boolean ArrayContainsNoCase(List v, Object obj)" whereas ArrayContains says "ArrayContains(array,object)".

Suggested ArrayContainsNoCase Syntax section ("boolean" doesn't belong in the Syntax section, nor does "obj" and "v" and "List".. why even is "v" there????):
-----------
ArrayContainsNoCase(array,object)
-----------

Issue 4: See Also section is incorrect. It says "Other closure functions."??

Suggested See Also section (and add ArrayContainsNoCase to the 'See also' section of ArrayContains doc):
-----------
ArrayContains, ArrayFind, ArrayFindNoCase
-----------

Issue 5: Parameters section is borked. It lists "v" and "obj" parameters. Huh?

Suggestion: Change "v" to "array" and "obj" to "object", to match ArrayContains doc.

Issue 6: Example does not illustrate a case-insensitive search.

Suggested Example section (and fix casing of "writeoutput" to "WriteOutput" in ArrayContains example) (and change "True" and "False" to "YES" and "NO" in ArrayContains example):
-----------
<cfscript>
  myArray=["Boat","Car"];
  WriteOutput(ArrayContains(myArray,"boat") & " | "); //returns YES since "Boat" is a member of myArray
  WriteOutput(ArrayContains(myArray,"train")); //returns NO since "Train" is not a member of myArray
</cfscript>
-----------

Issue 7: Output section is missing.

Suggestion: Copy the Output section from ArrayContains doc.

Attachments:

Comments:

Oops, I have a typo in my "Example" code suggestion. Both "ArrayContains" should be "ArrayContainsNoCase". Sorry and thanks!, -Aaron
Comment by Aaron N.
108 | February 14, 2018 09:46:26 AM GMT
Hi Adobe, This ticket is currently marked Closed/Fixed, but absolutely nothing has changed in the doc: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/arraycontainsnocase.html I'm guessing you updated the doc on the Staging server, and haven't pushed the update live? Could it please be pushed live? Thanks!, -Aaron
Comment by Aaron N.
109 | March 22, 2018 03:06:50 AM GMT
*bump* Not Fixed!
Comment by Aaron N.
29079 | June 18, 2018 04:22:32 AM GMT