Document String contains method (#6320) [ci fast]

---------

Signed-off-by: Ben Sherman <[email protected]>

Author: bentsherman

docs/reference/stdlib-types.md

@@ -805,9 +805,6 @@ The following operations are supported for strings:
 `[] : (String, int) -> char`
 : Given a string and an index, returns the character at the given index in the string.
 
-`in, !in : (String, String) -> boolean`
-: Given a substring and a string, returns `true` if the substring occurs anywhere in the string (or not).
-
 `~ : (String) -> Pattern`
 : Creates a regular expression from a string.
 : See [Pattern](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html) in the Java standard library for more information.
@@ -821,6 +818,9 @@ The following operations are supported for strings:
 
 The following methods are available for a string:
 
+`contains( str: String ) -> boolean`
+: Returns `true` if the given substring occurs anywhere in the string.
+
 `endsWith( suffix: String ) -> boolean`
 : Returns `true` if the string ends with the given suffix.
 

docs/script.md

@@ -152,8 +152,8 @@ assert !true == false           // logical NOT
 The `in` and `!in` operators can be used to test *membership*, i.e. whether a collection contains a value:
 
 ```nextflow
-assert 'lo wo' in 'Hello world!'
 assert 2 in [1, 2, 3]
+assert 'a' in [a: 1, b: 2, c: 3]
 ```
 
 Arithmetic operators can be used to do math:

modules/nf-lang/src/main/java/nextflow/script/types/shim/String.java

@@ -25,6 +25,11 @@
 @ShimType(java.lang.String.class)
 public interface String {
 
+    @Description("""
+        Returns `true` if the given substring occurs anywhere in the string.
+    """)
+    boolean contains(String str);
+
     @Description("""
         Returns `true` if the string ends with the given suffix.
     """)