Document that VintageNet persists by default

It was not clear from the docs and I had to read the code to be sure.
nerves-networking · Nov 9, 2021 · 9a4582c · 9a4582c
1 parent 68866ff
commit 9a4582c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/vintage_net.ex b/lib/vintage_net.ex
@@ -159,15 +159,15 @@ defmodule VintageNet do
   Options:
 
   * `:persist` - set to `false` to avoid persisting this configuration. System
-    restarts will revert to the previous configuration.
+    restarts will revert to the previous configuration. Defaults to true.
   """
   @spec configure(ifname(), map(), configure_options()) :: :ok | {:error, any()}
   def configure(ifname, config, options \\ []) do
     Interface.configure(ifname, config, options)
   end
 
   @doc """
-  Deconfigure settings for a specified interface.
+  Deconfigure and persists (by default) settings for a specified interface.
 
   Supports same options as `configure/3`
   """