1
0
mirror of https://github.com/janet-lang/janet synced 2025-06-13 20:14:12 +00:00

Tweak module/expand-path docs

This commit is contained in:
sogaiu 2021-01-13 22:16:54 +09:00
parent 4f2d1cdc00
commit e9bd108be9

View File

@ -699,16 +699,16 @@ static const JanetReg corelib_cfuns[] = {
{ {
"module/expand-path", janet_core_expand_path, "module/expand-path", janet_core_expand_path,
JDOC("(module/expand-path path template)\n\n" JDOC("(module/expand-path path template)\n\n"
"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, template, " "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. The replacements are as follows:\n\n" "used for importing files. The replacements are as follows:\n\n"
"\t:all:\tthe value of path verbatim\n" "* :all: -- the value of path verbatim\n\n"
"\t:cur:\tthe current file, or (dyn :current-file)\n" "* :cur: -- the current file, or (dyn :current-file)\n\n"
"\t:dir:\tthe directory containing the current file\n" "* :dir: -- the directory containing the current file\n\n"
"\t:name:\tthe name component of path, with extension if given\n" "* :name: -- the name component of path, with extension if given\n\n"
"\t:native:\tthe extension used to load natives, .so or .dll\n" "* :native: -- the extension used to load natives, .so or .dll\n\n"
"\t:sys:\tthe system path, or (dyn :syspath)") "* :sys: -- the system path, or (dyn :syspath)")
}, },
{ {
"int?", janet_core_check_int, "int?", janet_core_check_int,