1
0
mirror of https://github.com/janet-lang/janet synced 2024-11-18 06:34:48 +00:00

Merge pull request #1364 from sogaiu/module-expand-path-doc-tweak

Cosmetically tweak module/expand-path docstring
This commit is contained in:
Calvin Rose 2024-01-23 16:01:49 -08:00 committed by GitHub
commit 1394f1a5c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -110,12 +110,12 @@ JANET_CORE_FN(janet_core_expand_path,
"(module/expand-path path template)", "(module/expand-path path template)",
"Expands a path template as found in `module/paths` for `module/find`. " "Expands a path template as found in `module/paths` for `module/find`. "
"This takes in a path (the argument to require) and a template string, " "This takes in a path (the argument to require) and a template string, "
"to expand the path to a path that can be " "to expand the path to a path that can be used for importing files. "
"used for importing files. The replacements are as follows:\n\n" "The replacements are as follows:\n\n"
"* :all: -- the value of path verbatim.\n\n" "* :all: -- the value of path verbatim.\n\n"
"* :@all: -- Same as :all:, but if `path` starts with the @ character,\n" "* :@all: -- Same as :all:, but if `path` starts with the @ character, "
" the first path segment is replaced with a dynamic binding\n" "the first path segment is replaced with a dynamic binding "
" `(dyn <first path segment as keyword>)`.\n\n" "`(dyn <first path segment as keyword>)`.\n\n"
"* :cur: -- the current file, or (dyn :current-file)\n\n" "* :cur: -- the current file, or (dyn :current-file)\n\n"
"* :dir: -- the directory containing the current file\n\n" "* :dir: -- the directory containing the current file\n\n"
"* :name: -- the name component of path, with extension if given\n\n" "* :name: -- the name component of path, with extension if given\n\n"