Deprecate start_arguments

gleam-lang · Dec 24, 2023 · b5075da · b5075da
1 parent 0ad27f2
commit b5075da
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 - Updated for `gleam_stdlib` v0.33.0.
 - The `gleam/erlang/file` module has been removed.
+- The `start_arguments` function has been deprecated in favour of the `argv`
+  package.
 
 ## v0.23.1 - 2023-11-15
 

diff --git a/src/gleam/erlang.gleam b/src/gleam/erlang.gleam
@@ -94,6 +94,7 @@ fn get_start_arguments() -> List(Charlist)
 /// Get the arguments given to the program when it was started.
 ///
 /// This is sometimes called `argv` in other languages.
+@deprecated("Please use the argv package instead")
 pub fn start_arguments() -> List(String) {
   get_start_arguments()
   |> list.map(charlist.to_string)