Skip to content

docs: Add JSDoc documentation for register() function#7775

Closed
MzyzzG wants to merge 1 commit intoplotly:masterfrom
MzyzzG:patch-2
Closed

docs: Add JSDoc documentation for register() function#7775
MzyzzG wants to merge 1 commit intoplotly:masterfrom
MzyzzG:patch-2

Conversation

@MzyzzG
Copy link
Copy Markdown
Contributor

@MzyzzG MzyzzG commented Apr 28, 2026

Summary

Adds comprehensive JSDoc documentation to the register() function in registry.js.

Changes Made

  • Added JSDoc comment block above exports.register
  • Documents @param, @example, and @throws
  • Explains module types and registration process

Benefit to Maintainers

  • Helps new contributors understand how to register modules
  • Provides code examples for common use cases
  • Follows existing documentation patterns in the codebase
  • Zero functional impact, documentation only

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor

@emilykl
Copy link
Copy Markdown
Contributor

emilykl commented Apr 29, 2026

Hi @MzyzzG, the file already contains a detailed docstring for the register() function, so I'm going to close this PR.

@emilykl emilykl closed this Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants