Changeset: 9ebdad6c00af for MonetDB URL: http://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=9ebdad6c00af Modified Files: monetdb5/modules/mal/batExtensions.mal Branch: default Log Message:
Cleanup documentation. diffs (68 lines): diff --git a/monetdb5/modules/mal/batExtensions.mal b/monetdb5/modules/mal/batExtensions.mal --- a/monetdb5/modules/mal/batExtensions.mal +++ b/monetdb5/modules/mal/batExtensions.mal @@ -20,21 +20,17 @@ address CMDBATnew comment "Creates a new empty transient BAT, with head- and tail-types as indicated."; pattern bat.new(ht:oid, tt:any_1, size:int) :bat[:oid,:any_1] +address CMDBATnew; +pattern bat.new(ht:oid, tt:any_1, size:lng) :bat[:oid,:any_1] address CMDBATnew comment "Creates a new BAT with sufficient space."; -pattern bat.new(ht:oid, tt:any_1, size:lng) :bat[:oid,:any_1] -address CMDBATnew -comment "Creates a new BAT and allocate space."; - pattern bat.new_persistent(ht:oid, tt:any_1) :bat[:oid,:any_1] address CMDBATnew_persistent comment "Creates a new empty transient BAT in the persistent farm, with head- and tail-types as indicated."; pattern bat.new_persistent(ht:oid, tt:any_1, size:int) :bat[:oid,:any_1] -address CMDBATnew_persistent -comment "Creates a new BAT in the persistent farm with sufficient space."; - +address CMDBATnew_persistent; pattern bat.new_persistent(ht:oid, tt:any_1, size:lng) :bat[:oid,:any_1] address CMDBATnew_persistent comment "Creates a new BAT in the persistent farm and allocate space."; @@ -42,11 +38,12 @@ comment "Creates a new BAT in the persis pattern bat.new(b:bat[:oid,:any_1] ) :bat[:oid,:any_1] address CMDBATnewDerived; pattern bat.new(b:bat[:oid,:any_1], size:lng) :bat[:oid,:any_1] -address CMDBATnewDerived; +address CMDBATnewDerived +comment "Create a new BAT using the inherited structure"; command bat.new(nme:str):bat[:oid,:any_1] address CMDBATderivedByName -comment "Localize a bat by name and produce a clone."; +comment "Localize a BAT by name and produce a clone."; pattern bat.partition(b:bat[:oid,:any_1]):bat[:oid,:any_1]... address CMDBATpartition @@ -54,7 +51,7 @@ comment "Create a serie of slices over t pattern bat.partition(b:bat[:oid,:any_1], pieces:int, n:int):bat[:oid,:any_1] address CMDBATpartition2 -comment "Create the n-th slice over the BAT broken into severral pieces."; +comment "Create the n-th slice over the BAT broken into several pieces."; command bat.imprints(b:bat[:oid,:bte]) :void address CMDBATimprints; @@ -68,7 +65,7 @@ command bat.imprints(b:bat[:oid,:flt]) : address CMDBATimprints; command bat.imprints(b:bat[:oid,:dbl]) :void address CMDBATimprints -comment "Check/create an imprint index on the BAT"; +comment "Check for existence or create an imprint index on the BAT."; command bat.imprintsize(b:bat[:oid,:bte]):lng address CMDBATimprintsize; @@ -82,5 +79,5 @@ command bat.imprintsize(b:bat[:oid,:flt] address CMDBATimprintsize; command bat.imprintsize(b:bat[:oid,:dbl]):lng address CMDBATimprintsize -comment "Return the size of the imprints"; +comment "Return the storage size of the imprints index structure."; _______________________________________________ checkin-list mailing list [email protected] https://www.monetdb.org/mailman/listinfo/checkin-list
