From 49cffb40589d1aad54a580a5bac50387c665fbfc Mon Sep 17 00:00:00 2001
From: mpilquist <mpilquist@gmail.com>
Date: Wed, 1 May 2024 08:16:05 -0400
Subject: [PATCH] Add note to ScalaDoc

---
 core/shared/src/main/scala/scodec/bits/ByteVector.scala | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/core/shared/src/main/scala/scodec/bits/ByteVector.scala b/core/shared/src/main/scala/scodec/bits/ByteVector.scala
index 3aaa9363..df8d139e 100644
--- a/core/shared/src/main/scala/scodec/bits/ByteVector.scala
+++ b/core/shared/src/main/scala/scodec/bits/ByteVector.scala
@@ -1753,6 +1753,10 @@ object ByteVector extends ByteVectorCompanionCrossPlatform {
     * is not valid hexadecimal.
     *
     * The string may start with a `0x` and it may contain whitespace or underscore characters.
+    *
+    * Single-line comments are supported - by default, any text after a #, ;, or | charater is ignored
+    * until the start of the next line, though comment charaters are specified by the specified alphabet.
+    *
     * @group base
     */
   def fromHexDescriptive(
@@ -1858,6 +1862,10 @@ object ByteVector extends ByteVectorCompanionCrossPlatform {
     * not valid binary.
     *
     * The string may start with a `0b` and it may contain whitespace or underscore characters.
+    *
+    * Single-line comments are supported - by default, any text after a #, ;, or | charater is ignored
+    * until the start of the next line, though comment charaters are specified by the specified alphabet.
+    *
     * @group base
     */
   def fromBinDescriptive(