LearnNewsExamplesServices
Frontmatter
id8570
titleEnhance Neo.mjs JSDoc to explicitly mention core/Util.mjs augmentation
stateClosed
labels
documentationenhancementai
assigneestobiu
createdAtJan 12, 2026, 2:50 AM
updatedAtJan 12, 2026, 2:55 AM
githubUrlhttps://github.com/neomjs/neo/issues/8570
authortobiu
commentsCount1
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtJan 12, 2026, 2:55 AM

Enhance Neo.mjs JSDoc to explicitly mention core/Util.mjs augmentation

Closed v11.20.0 documentationenhancementai
tobiu
tobiu commented on Jan 12, 2026, 2:50 AM

src/core/Util.mjs augments the global Neo singleton with utility methods (e.g., Neo.isArray, Neo.isObject) using Neo.applyFromNs. This behavior is not currently documented in the top-level JSDoc of src/Neo.mjs.

Goal: Update the JSDoc in src/Neo.mjs to explicitly state that the Neo namespace is enhanced by src/core/Util.mjs and lists the key methods provided. This ensures that AI agents (reading Neo.mjs on startup) and developers understand where these global utilities come from.

Changes:

  1. Update the @summary or main description of src/Neo.mjs.
  2. Add a note about Neo.core.Util augmentation.
  3. Ensure the @borrows tags are accurate and reflective of this relationship.
tobiu added the documentation label on Jan 12, 2026, 2:50 AM
tobiu added the enhancement label on Jan 12, 2026, 2:50 AM
tobiu added the ai label on Jan 12, 2026, 2:50 AM
tobiu referenced in commit c0ef878 - "docs: Document core augmentation and Logger borrows in Neo.mjs (#8570)" on Jan 12, 2026, 2:54 AM
tobiu
tobiu Jan 12, 2026, 2:54 AM

Input from Gemini 3 Pro:

✦ I have updated the src/Neo.mjs top-level JSDoc.

  • Added an explicit note about the Neo namespace being augmented by core modules (Util, Compare).
  • Clarified that importing src/core/_export.mjs (or specific modules) is often required to use these augmented methods.
  • Added the @borrows tags for Neo.util.Logger methods (error, info, log, logError, warn).

Closing as completed.

tobiu closed this issue on Jan 12, 2026, 2:55 AM
tobiu assigned to @tobiu on Jan 12, 2026, 2:55 AM