improve split() docs

Summary:
From reading the docs, I assumed that casting exceptions would be caught.  Let's clarify this.

Test Plan: readingiskey

Reviewed By: yfeldblum@fb.com

Subscribers: folly-diffs@, yfeldblum, chalfant

FB internal diff: D1960186

Signature: t1:1960186:1427920471:b7aa2af38a90a986418b98294fc0f69e678f0d1e

diff --git a/folly/String.h b/folly/String.h
index 7da981e873cc92e1bc5daac86d39c5c5dd22b02e..167a6b5cfd947ee925184cb4313046aa22449299 100644 (file)
--- a/folly/String.h
+++ b/folly/String.h
@@ -436,7 +436,9 @@ void splitTo(const Delim& delimiter,
  * Split a string into a fixed number of string pieces and/or numeric types
  * by delimiter. Any numeric type that folly::to<> can convert to from a
  * string piece is supported as a target. Returns 'true' if the fields were
- * all successfully populated.
+ * all successfully populated.  Returns 'false' if there were too few fields
+ * in the input, or too many fields if exact=true.  Casting exceptions will
+ * not be caught.
  *
  * Examples:
  *