funcsave: add documentation for feature added in 3a402b19b

This commit is contained in:
David Adam
2022-01-03 23:03:29 +08:00
parent 06666f3d1d
commit e86a84765f
2 changed files with 3 additions and 1 deletions

View File

@@ -25,7 +25,7 @@ The following options are available:
- ``-d DESCRIPTION`` or ``--description=DESCRIPTION`` changes the description of this function.
- ``-e`` or ``--erase`` causes the specified functions to be erased. This also means that it is prevented from autoloading.
- ``-e`` or ``--erase`` causes the specified functions to be erased. This also means that it is prevented from autoloading in the current session. Use :ref:`funcsave <cmd-funcsave>` to remove the saved copy.
- ``-D`` or ``--details`` reports the path name where the specified function is defined or could be autoloaded, ``stdin`` if the function was defined interactively or on the command line or by reading stdin, ``-`` if the function was created via :ref:`source <cmd-source>`, and ``n/a`` if the function isn't available. (Functions created via :ref:`alias <cmd-alias>` will return ``-``, because ``alias`` uses ``source`` internally.) If the ``--verbose`` option is also specified then five lines are written: