add note that codex is used for documentation.
This commit is contained in:
		
							parent
							
								
									5dbe825934
								
							
						
					
					
						commit
						e9ccc51a08
					
				
							
								
								
									
										10
									
								
								README.txt
								
								
								
								
							
							
						
						
									
										10
									
								
								README.txt
								
								
								
								
							|  | @ -53,3 +53,13 @@ Miscellanea | ||||||
| * mkkw | * mkkw | ||||||
| * zip | * zip | ||||||
| * defclass! | * defclass! | ||||||
|  | 
 | ||||||
|  | Documentation | ||||||
|  | ============= | ||||||
|  | 
 | ||||||
|  | Documentation is generated with codex [1]: | ||||||
|  | 
 | ||||||
|  |     CL-USER> (ql:quickload :codex) ;; if not installed | ||||||
|  |     (:CODEX) | ||||||
|  |     CL-USER> (codex:document :kutils) | ||||||
|  |     NIL | ||||||
|  |  | ||||||
|  | @ -11,4 +11,3 @@ | ||||||
|                (:file "kutils") |                (:file "kutils") | ||||||
|                (:file "kutils-hash-tables") |                (:file "kutils-hash-tables") | ||||||
| 	       (:file "macros"))) | 	       (:file "macros"))) | ||||||
| 
 |  | ||||||
|  |  | ||||||
|  | @ -105,7 +105,7 @@ vector. Otherwise, attempt to map it into a vector." | ||||||
| 	((atom arg) | 	((atom arg) | ||||||
| 	 (let ((v (new-vector))) | 	 (let ((v (new-vector))) | ||||||
| 	   (vector-push-extend arg v) | 	   (vector-push-extend arg v) | ||||||
| 	   v))	 | 	   v)) | ||||||
|         (t (mapv #'identity arg)))) |         (t (mapv #'identity arg)))) | ||||||
| 
 | 
 | ||||||
| (defun extend-vector (v) | (defun extend-vector (v) | ||||||
|  | @ -175,3 +175,9 @@ those that do not satisfy @c(pred)." | ||||||
|     ((listp seq)   (partition-list pred seq)) |     ((listp seq)   (partition-list pred seq)) | ||||||
|     ((vectorp seq) (partition-vector pred seq)) |     ((vectorp seq) (partition-vector pred seq)) | ||||||
|     (t nil))) |     (t nil))) | ||||||
|  | 
 | ||||||
|  | (defun in-range (number low high) | ||||||
|  |   "Returns T if LOW >= NUMBER <= HIGH." | ||||||
|  |   (and | ||||||
|  |    (<= number high) | ||||||
|  |    (>= number low))) | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue