Add notes on use of lsb namespaces from outside cljam

chrovis · Dec 8, 2023 · 8612caa · 8612caa
1 parent c01eb05
commit 8612caa
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/cljam/io/util/lsb/data_io.clj b/src/cljam/io/util/lsb/data_io.clj
@@ -1,5 +1,8 @@
 (ns cljam.io.util.lsb.data-io
-  "Functions for reading little-endian data using DataInput."
+  "Functions for reading little-endian data using DataInput.
+
+  NOTE: This namespace is intended to be used only from within cljam, and should
+  not be used outside cljam."
   (:refer-clojure :exclude [read-string])
   (:require [cljam.io.util.byte-buffer :as bb])
   (:import [java.io ByteArrayOutputStream DataInput]))

diff --git a/src/cljam/io/util/lsb/io_stream.clj b/src/cljam/io/util/lsb/io_stream.clj
@@ -1,5 +1,8 @@
 (ns cljam.io.util.lsb.io-stream
-  "Functions for reading/writing little-endian data using InputStream/OutputStream."
+  "Functions for reading/writing little-endian data using InputStream/OutputStream.
+
+  NOTE: This namespace is intended to be used only from within cljam, and should
+  not be used outside cljam."
   (:refer-clojure :exclude [read-string])
   (:require [cljam.io.util.byte-buffer :as bb]
             [cljam.util :refer [string->bytes]])