option doc examples

1 files changed, 64 insertions, 64 deletions

diff --git a/src/gleam/option.gleam b/src/gleam/option.gleam
index 6015c0f..6224217 100644
--- a/src/gleam/option.gleam
+++ b/src/gleam/option.gleam
@@ -31,13 +31,13 @@ fn do_all(list: List(Option(a)), acc: List(a)) -> Option(List(a)) {
 /// ## Examples
 ///
 /// ```gleam
-/// > all([Some(1), Some(2)])
-/// Some([1, 2])
+/// all([Some(1), Some(2)])
+/// // -> Some([1, 2])
 /// ```
 ///
 /// ```gleam
-/// > all([Some(1), None])
-/// None
+/// all([Some(1), None])
+/// // -> None
 /// ```
 ///
 pub fn all(list: List(Option(a))) -> Option(List(a)) {
@@ -49,13 +49,13 @@ pub fn all(list: List(Option(a))) -> Option(List(a)) {
 /// ## Examples
 ///
 /// ```gleam
-/// > is_some(Some(1))
-/// True
+/// is_some(Some(1))
+/// // -> True
 /// ```
 ///
 /// ```gleam
-/// > is_some(None)
-/// False
+/// is_some(None)
+/// // -> False
 /// ```
 ///
 pub fn is_some(option: Option(a)) -> Bool {
@@ -67,13 +67,13 @@ pub fn is_some(option: Option(a)) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// > is_none(Some(1))
-/// False
+/// is_none(Some(1))
+/// // -> False
 /// ```
 ///
 /// ```gleam
-/// > is_none(None)
-/// True
+/// is_none(None)
+/// // -> True
 /// ```
 ///
 pub fn is_none(option: Option(a)) -> Bool {
@@ -85,13 +85,13 @@ pub fn is_none(option: Option(a)) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// > to_result(Some(1), "some_error")
-/// Ok(1)
+/// to_result(Some(1), "some_error")
+/// // -> Ok(1)
 /// ```
 ///
 /// ```gleam
-/// > to_result(None, "some_error")
-/// Error("some_error")
+/// to_result(None, "some_error")
+/// // -> Error("some_error")
 /// ```
 ///
 pub fn to_result(option: Option(a), e) -> Result(a, e) {
@@ -106,13 +106,13 @@ pub fn to_result(option: Option(a), e) -> Result(a, e) {
 /// ## Examples
 ///
 /// ```gleam
-/// > from_result(Ok(1))
-/// Some(1)
+/// from_result(Ok(1))
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > from_result(Error("some_error"))
-/// None
+/// from_result(Error("some_error"))
+/// // -> None
 /// ```
 ///
 pub fn from_result(result: Result(a, e)) -> Option(a) {
@@ -127,13 +127,13 @@ pub fn from_result(result: Result(a, e)) -> Option(a) {
 /// ## Examples
 ///
 /// ```gleam
-/// > unwrap(Some(1), 0)
-/// 1
+/// unwrap(Some(1), 0)
+/// // -> 1
 /// ```
 ///
 /// ```gleam
-/// > unwrap(None, 0)
-/// 0
+/// unwrap(None, 0)
+/// // -> 0
 /// ```
 ///
 pub fn unwrap(option: Option(a), or default: a) -> a {
@@ -148,13 +148,13 @@ pub fn unwrap(option: Option(a), or default: a) -> a {
 /// ## Examples
 ///
 /// ```gleam
-/// > lazy_unwrap(Some(1), fn() { 0 })
-/// 1
+/// lazy_unwrap(Some(1), fn() { 0 })
+/// // -> 1
 /// ```
 ///
 /// ```gleam
-/// > lazy_unwrap(None, fn() { 0 })
-/// 0
+/// lazy_unwrap(None, fn() { 0 })
+/// // -> 0
 /// ```
 ///
 pub fn lazy_unwrap(option: Option(a), or default: fn() -> a) -> a {
@@ -173,13 +173,13 @@ pub fn lazy_unwrap(option: Option(a), or default: fn() -> a) -> a {
 /// ## Examples
 ///
 /// ```gleam
-/// > map(over: Some(1), with: fn(x) { x + 1 })
-/// Some(2)
+/// map(over: Some(1), with: fn(x) { x + 1 })
+/// // -> Some(2)
 /// ```
 ///
 /// ```gleam
-/// > map(over: None, with: fn(x) { x + 1 })
-/// None
+/// map(over: None, with: fn(x) { x + 1 })
+/// // -> None
 /// ```
 ///
 pub fn map(over option: Option(a), with fun: fn(a) -> b) -> Option(b) {
@@ -194,18 +194,18 @@ pub fn map(over option: Option(a), with fun: fn(a) -> b) -> Option(b) {
 /// ## Examples
 ///
 /// ```gleam
-/// > flatten(Some(Some(1)))
-/// Some(1)
+/// flatten(Some(Some(1)))
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > flatten(Some(None))
-/// None
+/// flatten(Some(None))
+/// // -> None
 /// ```
 ///
 /// ```gleam
-/// > flatten(None)
-/// None
+/// flatten(None)
+/// // -> None
 /// ```
 ///
 pub fn flatten(option: Option(Option(a))) -> Option(a) {
@@ -228,23 +228,23 @@ pub fn flatten(option: Option(Option(a))) -> Option(a) {
 /// ## Examples
 ///
 /// ```gleam
-/// > then(Some(1), fn(x) { Some(x + 1) })
-/// Some(2)
+/// then(Some(1), fn(x) { Some(x + 1) })
+/// // -> Some(2)
 /// ```
 ///
 /// ```gleam
-/// > then(Some(1), fn(x) { Some(#("a", x)) })
-/// Some(#("a", 1))
+/// then(Some(1), fn(x) { Some(#("a", x)) })
+/// // -> Some(#("a", 1))
 /// ```
 ///
 /// ```gleam
-/// > then(Some(1), fn(_) { None })
-/// None
+/// then(Some(1), fn(_) { None })
+/// // -> None
 /// ```
 ///
 /// ```gleam
-/// > then(None, fn(x) { Some(x + 1) })
-/// None
+/// then(None, fn(x) { Some(x + 1) })
+/// // -> None
 /// ```
 ///
 pub fn then(option: Option(a), apply fun: fn(a) -> Option(b)) -> Option(b) {
@@ -259,23 +259,23 @@ pub fn then(option: Option(a), apply fun: fn(a) -> Option(b)) -> Option(b) {
 /// ## Examples
 ///
 /// ```gleam
-/// > or(Some(1), Some(2))
-/// Some(1)
+/// or(Some(1), Some(2))
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > or(Some(1), None)
-/// Some(1)
+/// or(Some(1), None)
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > or(None, Some(2))
-/// Some(2)
+/// or(None, Some(2))
+/// // -> Some(2)
 /// ```
 ///
 /// ```gleam
-/// > or(None, None)
-/// None
+/// or(None, None)
+/// // -> None
 /// ```
 ///
 pub fn or(first: Option(a), second: Option(a)) -> Option(a) {
@@ -290,23 +290,23 @@ pub fn or(first: Option(a), second: Option(a)) -> Option(a) {
 /// ## Examples
 ///
 /// ```gleam
-/// > lazy_or(Some(1), fn() { Some(2) })
-/// Some(1)
+/// lazy_or(Some(1), fn() { Some(2) })
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > lazy_or(Some(1), fn() { None })
-/// Some(1)
+/// lazy_or(Some(1), fn() { None })
+/// // -> Some(1)
 /// ```
 ///
 /// ```gleam
-/// > lazy_or(None, fn() { Some(2) })
-/// Some(2)
+/// lazy_or(None, fn() { Some(2) })
+/// // -> Some(2)
 /// ```
 ///
 /// ```gleam
-/// > lazy_or(None, fn() { None })
-/// None
+/// lazy_or(None, fn() { None })
+/// // -> None
 /// ```
 ///
 pub fn lazy_or(first: Option(a), second: fn() -> Option(a)) -> Option(a) {
@@ -337,8 +337,8 @@ fn do_values(list: List(Option(a)), acc: List(a)) -> List(a) {
 /// ## Examples
 ///
 /// ```gleam
-/// > values([Some(1), None, Some(3)])
-/// [1, 3]
+/// values([Some(1), None, Some(3)])
+/// // -> [1, 3]
 /// ```
 ///
 pub fn values(options: List(Option(a))) -> List(a) {