chore: updated docs

Author: ovflowd

src/parser.mjs

@@ -41,7 +41,7 @@ const createParser = () => {
    * with numerous transformations into API doc Metadata entries.
    *
    * This transformer iterates on several sort of AST Nodes and applies transformations
-   * and then grabs a subtree of Nodes (groupped by a Heading Node) and then stringifies them into a VFile
+   * and then grabs a subtree of Nodes (grouped by a Heading Node) and then stringifies them into a VFile
    * and finally creates a Metadata entry for the given section.
    *
    * @type {import('unified').Plugin<[{

src/utils/unist.mjs

@@ -38,6 +38,8 @@ export const transformNodesToString = nodes => {
  * based on test conditions related to a Node's position relative to another one
  * being before or not the other Node
  *
+ * NOTE: Not yet used, but probably going to be used by the JSON generator.
+ *
  * @param {import('unist').Node | undefined} nodeA The Node to be used as a position reference to check against
  *  the other Node. If the other Node is before this one, the callback will be called.
  * @param {import('unist').Node | undefined} nodeB The Node to be checked against the position of the first Node