aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2020-04-17 00:17:59 +0100
committerLouis Pilfold <louis@lpil.uk>2020-04-17 00:17:59 +0100
commite0cb8e9d9b0f6e733bdce59dfbfdc94d06bfb340 (patch)
tree25409343ff24801c6f62d3f2746a9de28d99c07d
parent9fcbda5af8e562dc1120b772e94159d8ef791eb5 (diff)
downloadgleam_stdlib-e0cb8e9d9b0f6e733bdce59dfbfdc94d06bfb340.tar.gz
gleam_stdlib-e0cb8e9d9b0f6e733bdce59dfbfdc94d06bfb340.zip
Correct mistakes in atom docs
-rw-r--r--src/gleam/atom.gleam5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/gleam/atom.gleam b/src/gleam/atom.gleam
index 46052b1..c8fc79c 100644
--- a/src/gleam/atom.gleam
+++ b/src/gleam/atom.gleam
@@ -15,7 +15,8 @@
///
pub external type Atom;
-/// Error returned when a given Atom does not currently exist
+/// An error returned when no atom is found in the virtual machine's atom table
+/// for a given string when calling the [`from_string`](#from_string) function.
pub type FromStringError {
AtomNotLoaded
}
@@ -23,7 +24,7 @@ pub type FromStringError {
/// Find an existing Atom for the given String.
///
/// If no atom is found in the virtual machine's atom table for the String then
-/// an gaerror is returned.
+/// an error is returned.
///
/// ## Examples
///