From 6854ba27e2ce267e256b0a09117cc327ddb880cc Mon Sep 17 00:00:00 2001
From: Larpon <Larpon@users.noreply.github.com>
Date: Fri, 18 Dec 2020 23:27:35 +0100
Subject: [PATCH] builtin: add missing fn documentation to option.v, fix naming
 of arguments. (#7386)

---
 vlib/builtin/option.v | 40 ++++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 18 deletions(-)

diff --git a/vlib/builtin/option.v b/vlib/builtin/option.v
index 0d4e075169..61a5d73a51 100644
--- a/vlib/builtin/option.v
+++ b/vlib/builtin/option.v
@@ -2,6 +2,7 @@
 // Use of this source code is governed by an MIT license
 // that can be found in the LICENSE file.
 module builtin
+
 /*
 struct Option2<T> {
 	ok bool
@@ -11,31 +12,29 @@ struct Option2<T> {
 	data T
 }
 */
-
+// OptionBase is the the base of V's internal optional return system.
 struct OptionBase {
 	ok      bool
 	is_none bool
 	error   string
 	ecode   int
-
 	// Data is trailing after ecode
 	// and is not included in here but in the
 	// derived Option_xxx types
 }
 
 // `fn foo() ?Foo { return foo }` => `fn foo() ?Foo { return opt_ok(foo); }`
-fn opt_ok2(data voidptr, mut option &OptionBase, size int) {
+fn opt_ok2(data voidptr, mut option OptionBase, size int) {
 	unsafe {
-		*option = OptionBase {
+		*option = OptionBase{
 			ok: true
 		}
-
 		// use ecode to get the end of OptionBase and then memcpy into it
 		C.memcpy(byteptr(&option.ecode) + sizeof(int), data, size)
 	}
 }
 
-// Old option type used for bootstrapping
+// Option is the old option type used for bootstrapping
 struct Option {
 	ok      bool
 	is_none bool
@@ -43,17 +42,18 @@ struct Option {
 	ecode   int
 }
 
+// str returns the string representation of the Option.
 pub fn (o Option) str() string {
-   if o.ok && !o.is_none {
-	  return 'Option{ ok }'
-   }
-   if o.is_none {
-	  return 'Option{ none }'
-   }
-   return 'Option{ error: "${o.error}" }'
+	if o.ok && !o.is_none {
+		return 'Option{ ok }'
+	}
+	if o.is_none {
+		return 'Option{ none }'
+	}
+	return 'Option{ error: "$o.error" }'
 }
 
-// used internally when returning `none`
+// opt_none is used internally when returning `none`.
 fn opt_none() Option {
 	return Option{
 		ok: false
@@ -61,19 +61,23 @@ fn opt_none() Option {
 	}
 }
 
-pub fn error(s string) Option {
+// error returns an optional containing the error given in `message`.
+// `if ouch { return error('an error occurred') }`
+pub fn error(message string) Option {
 	return Option{
 		ok: false
 		is_none: false
-		error: s
+		error: message
 	}
 }
 
-pub fn error_with_code(s string, code int) Option {
+// error_with_code returns an optional containing both error `message` and error `code`.
+// `if ouch { return error_with_code('an error occurred',1) }`
+pub fn error_with_code(message string, code int) Option {
 	return Option{
 		ok: false
 		is_none: false
-		error: s
+		error: message
 		ecode: code
 	}
 }