Merge pull request #1 from ambaker1/bugs-and-typos

Bugs and typos

README.md

@@ -1,5 +1,7 @@
-# ndlist
-N-Dimensional List Implementation in Tcl
+# N-Dimensional Lists (ndlist)
+Utilities for accessing, modifying and manipulating N-Dimensional lists in Tcl.
+
+Also adds the "ndlist" object variable type, using the type framework provided by the [vutil](https://github.com/ambaker1/vutil) package.
 
 Full documentation [here](https://raw.githubusercontent.com/ambaker1/ndlist/main/doc/ndlist.pdf).
 

build.tcl

@@ -1,7 +1,7 @@
 package require tin 1.0
 tin import assert from tin
 tin import tcltest
-set version 0.1
+set version 0.1.1
 set vutil_version 1.1
 set config [dict create VERSION $version VUTIL_VERSION $vutil_version]
 tin bake src build $config

doc/ndlist.tex

@@ -16,7 +16,7 @@
 \begin{abstract}
 \begin{center}
 The ``ndlist'' module provides tools for vector, matrix, and tensor manipulation and processing, where vectors are represented by Tcl lists, and matrices are represented by nested Tcl lists, and higher dimension lists represented by additional levels of nesting. 
-Additionally, this package provides the ``ndlist'' object variable type.
+Additionally, this package provides the ``ndlist'' object variable type, using the object variable framework provided by the \textcolor{blue}{\href{https://github.com/ambaker1/vutil}{vutil}} package.
 \end{center}
 \end{abstract}
 \clearpage
@@ -336,7 +336,8 @@ \subsection{Standard Methods}
 \method{ndlist}{:=} \$expr \\
 \method{ndlist}{::=} \$body \\
 \method{ndlist}{info} <\$field> \\
-\method{ndlist}{print} <-nonewline> <\$channelID>
+\method{ndlist}{print} <-nonewline> <\$channelID> \\
+\method{ndlist}{destroy}
 \end{syntax}
 \begin{args}
 \$refName & Reference name to copy to. \\
@@ -381,7 +382,7 @@ \subsection{Index Method}
 \quad = \$value  & \quad Assign \texttt{\$value} to range after passing through the \cmdlink{ndlist} command. \\
 \quad .= \$oper & \quad Modify range in place using \cmdlink{nop}. \\
 \quad := \$expr & \quad Modify range in place using \cmdlink{nexpr}. \\
-\quad := \$body & \quad Modify range in place using \cmdlink{neval}. 
+\quad ::= \$body & \quad Modify range in place using \cmdlink{neval}. 
 \end{args}
 
 \begin{example}{ND List Object Access/Manipulation}

doc/template/version.tex

@@ -1 +1 @@
-\newcommand{\version}{0.1}
+\newcommand{\version}{0.1.1}

install.tcl

@@ -1,4 +1,4 @@
 package require tin 1.0
 tin depend vutil 1.1
-set dir [tin mkdir -force ndlist 0.1]
+set dir [tin mkdir -force ndlist 0.1.1]
 file copy pkgIndex.tcl ndlist.tcl README.md LICENSE $dir

ndlist.tcl

@@ -522,7 +522,7 @@ proc ::ndlist::Transpose {matrix} {
 # Insert ndlists in other ndlists, verifying that dimensions are compatible.
 #
 # Syntax:
-# ninsert $nd $ndlist $axis $index $sublist
+# ninsert $nd $ndlist $axis $index $sublist <$axis>
 #
 # Arguments:
 # nd            Number of dimensions
@@ -990,7 +990,6 @@ proc ::ndlist::nset {varName args} {
 # nreplace --
 #
 # Replace portion of ndlist - return new list, same dimension. 
-# Can also return an ndobject.
 #
 # Syntax:
 # nreplace $ndlist $i1 $i2 ... $sublist
@@ -1916,4 +1915,4 @@ proc ::ndlist::k {} {
 ################################################################################
 
 # Finally, provide the package
-package provide ndlist 0.1
+package provide ndlist 0.1.1

pkgIndex.tcl

@@ -1,2 +1,2 @@
 if {![package vsatisfies [package provide Tcl] 8.6]} {return}
-package ifneeded ndlist 0.1 [list source [file join $dir ndlist.tcl]]
+package ifneeded ndlist 0.1.1 [list source [file join $dir ndlist.tcl]]

src/ndlist.tin

@@ -522,7 +522,7 @@ proc ::ndlist::Transpose {matrix} {
 # Insert ndlists in other ndlists, verifying that dimensions are compatible.
 #
 # Syntax:
-# ninsert $nd $ndlist $axis $index $sublist
+# ninsert $nd $ndlist $axis $index $sublist <$axis>
 #
 # Arguments:
 # nd            Number of dimensions
@@ -990,7 +990,6 @@ proc ::ndlist::nset {varName args} {
 # nreplace --
 #
 # Replace portion of ndlist - return new list, same dimension. 
-# Can also return an ndobject.
 #
 # Syntax:
 # nreplace $ndlist $i1 $i2 ... $sublist