Skip to content

adds JSDoc to public symbols.#39

Merged
threepointone merged 2 commits intocloudflare:mainfrom
elithrar:silverlock/jsdoc
Feb 27, 2025
Merged

adds JSDoc to public symbols.#39
threepointone merged 2 commits intocloudflare:mainfrom
elithrar:silverlock/jsdoc

Conversation

@elithrar
Copy link
Copy Markdown
Collaborator

Used Claude 3.7 with the following prompt:

Generate valid JSDoc comments for the public types in the agents package.
Comments should be generated for all public types, including classes,
interfaces, and functions. Comments should include a description of the type,
its parameters, and its return value. Be concise, and do not include any
unnecessary details.

Return the entirety of each file separately, and include all other code, even
if there are no JSDOc comments for those symbols.

Used Claude 3.7 with the following prompt:

  Generate valid JSDoc comments for the public types in the `agents` package.
  Comments should be generated for all public types, including classes,
  interfaces, and functions. Comments should include a description of the type,
  its parameters, and its return value. Be concise, and do not include any
  unnecessary details.

  Return the entirety of each file separately, and include all other code, even
  if there are no JSDOc comments for those symbols.
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Feb 27, 2025

🦋 Changeset detected

Latest commit: 441a7c3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
agents-sdk Patch
hono-agents Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Copy Markdown
Contributor

@threepointone threepointone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is dope, thank you!

@threepointone threepointone merged commit 2afea20 into cloudflare:main Feb 27, 2025
1 check passed
@threepointone threepointone mentioned this pull request Feb 27, 2025
@craigsdennis
Copy link
Copy Markdown
Collaborator

This is the good part of the timeline

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.

3 participants