Skip to content

Commit

Permalink
update module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
curtisma committed Mar 5, 2024
1 parent e28f5cf commit c90f6cc
Showing 1 changed file with 7 additions and 20 deletions.
27 changes: 7 additions & 20 deletions virtue/skill_package/Module.ils
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@ let((Module
Module = let(()

procedure(IsModule(input "g")
tablep(input) && tablep(input['_module])
"returns 't if the input is a Virtue module"
tablep(input) && tablep(input['__metadata__])
)

procedure(New(module_symbol
@key module package (description "") "sggt")
"Create a new SKILL module.
@param module_symbol A symbol of the module name
@param module The existing module table or a decomposed property list (DPL)
of functions to include as public functions. 'theEnvironment' be provided
to add add all the functions in the environment.
of functions to include as public functions. 'theEnvironment' can be
provided to add add all the functions in the environment.
@param package The top-level package which defines this module
@brief Create a new SKILL module."
let((module_table metadata)
Expand Down Expand Up @@ -69,9 +70,10 @@ Module = let(()
putprop(object_dpl Module->Method(method object_dpl) method_symbol)
)

procedure(GetModuleTable(module "g")
procedure(GetModuleMetadata(module "g")
"Returns a table of metadata about the module."
if(tablep(module) then
module['_module]
module['__metadata__]
else
error("Input module must be a table")
)
Expand All @@ -98,21 +100,6 @@ Module = let(()
)
))

/*
procedure(UninitializeModule(module "g")
if(symbolp(module) then
let((module_props)
module_props = module_VrtImport[module]->?
when(

)
)
module = VrtImport[module]
remove(module VrtImport)
)
)
*/

list(nil
'New New
'IsModule IsModule
Expand Down

0 comments on commit c90f6cc

Please sign in to comment.