Document some String primitives for clarity

eregon · eregon · commit 74d7abee4fc5 · 2021-07-06T12:54:27.000+02:00
diff --git a/src/main/java/org/truffleruby/core/string/StringNodes.java b/src/main/java/org/truffleruby/core/string/StringNodes.java
@@ -4398,6 +4398,7 @@ protected int notValidUtf8(Object string, int byteIndex,
         }
     }
 
+    /** Search pattern in string starting after offset characters, and return a character index or nil */
     @Primitive(name = "string_character_index", lowerFixnum = 2)
     @NodeChild(value = "string", type = RubyNode.class)
     @NodeChild(value = "pattern", type = RubyNode.class)
@@ -4508,6 +4509,7 @@ protected boolean patternFits(Rope stringRope, Rope patternRope, int offset) {
         }
     }
 
+    /** Search pattern in string starting after offset bytes, and return a byte index or nil */
     @Primitive(name = "string_byte_index", lowerFixnum = 2)
     @NodeChild(value = "string", type = RubyNode.class)
     @NodeChild(value = "pattern", type = RubyNode.class)

Original file line number	Diff line number	Diff line change
`@@ -4398,6 +4398,7 @@ protected int notValidUtf8(Object string, int byteIndex,`
`4398`	`4398`	`}`
`4399`	`4399`	`}`
`4400`	`4400`
	`4401`	`+ /** Search pattern in string starting after offset characters, and return a character index or nil */`
`4401`	`4402`	`@Primitive(name = "string_character_index", lowerFixnum = 2)`
`4402`	`4403`	`@NodeChild(value = "string", type = RubyNode.class)`
`4403`	`4404`	`@NodeChild(value = "pattern", type = RubyNode.class)`
`@@ -4508,6 +4509,7 @@ protected boolean patternFits(Rope stringRope, Rope patternRope, int offset) {`
`4508`	`4509`	`}`
`4509`	`4510`	`}`
`4510`	`4511`
	`4512`	`+ /** Search pattern in string starting after offset bytes, and return a byte index or nil */`
`4511`	`4513`	`@Primitive(name = "string_byte_index", lowerFixnum = 2)`
`4512`	`4514`	`@NodeChild(value = "string", type = RubyNode.class)`
`4513`	`4515`	`@NodeChild(value = "pattern", type = RubyNode.class)`