Add JSDoc documentation for repository #1551

madjin · 2024-12-29T03:17:57Z

Summary of Changes

This PR adds JSDoc documentation to the entire repository for improved code readability and documentation.

Summary of Modified Files

/home/runner/work/eliza/eliza/packages/_examples/plugin/src/actions/sampleAction.ts
/home/runner/work/eliza/eliza/packages/_examples/plugin/src/evaluators/sampleEvalutor.ts
/home/runner/work/eliza/eliza/packages/_examples/plugin/src/index.ts
...

Instructions for Reviewers

Please review the changes in all modified files to ensure that the JSDoc documentation accurately reflects the code functionality and provides useful information for developers. Thank you!

odilitime · 2024-12-29T03:28:40Z

Putting **/ instead of */ in some instances causing the source code not to parse. We should close this, then get that bug fixed then try again

luduvigo

Was playing around with the repo and this PR looked very instructive, but seems far from being merge-ready 😅

luduvigo · 2024-12-30T16:46:36Z

packages/client-discord/src/attachments.ts

+ * Class representing the AttachmentManager.
+ */
+ *//**
+ * Create an AttachmentManager object to manage attachments.


I think we have a problem here

luduvigo · 2024-12-30T16:48:40Z

packages/client-farcaster/src/client.ts

+ *
+ * @class
+ */
+ */


Please fix this one

luduvigo · 2024-12-30T16:48:59Z

packages/client-farcaster/src/interactions.ts

+/**
+ * Class representing a Farcaster Interaction Manager.
+ */
+*/


Please fix this one

luduvigo · 2024-12-30T16:49:42Z

packages/client-lens/src/providers/StorjProvider.ts

+ * StorjProvider class for interacting with Storj IPFS API.
+ * @constructor
+ * @param {IAgentRuntime} runtime - The runtime environment.
+ */


Please fix this one

luduvigo · 2024-12-30T16:50:04Z

packages/client-slack/src/events.ts

+ * @param {WebClient} client - The WebClient instance for interacting with Slack API
+ * @param {MessageManager} messageManager - The message manager for handling Slack messages
+ */ 
+ */


Please fix this one

luduvigo · 2024-12-30T16:51:38Z

packages/client-telegram/src/telegramClient.ts

+/**
+ * Class representing a Telegram client for handling bot functionality.
+ */
+ */


Please fix this one

luduvigo · 2024-12-30T16:51:56Z

packages/client-twitter/src/base.ts

+ * directly from the base class, it will throw an error
+ * instructing the developer to call it from a subclass.
+ */
+ */


Please fix this one

luduvigo · 2024-12-30T16:52:27Z

packages/core/src/cache.ts

+ *
+ * @template CacheAdapter - The type of cache adapter used by the manager.
+ */
+ */


Please fix this one

luduvigo · 2024-12-30T16:52:35Z

packages/core/src/database.ts

+ * Database Adapter interface for interacting with a database.
+ * @interface
+ */
+ */


Please fix this one

madjin added 30 commits December 28, 2024 22:15

docs: Add JSDoc documentation to fees-types.ts

94fcba4

docs: Add JSDoc documentation to futures-types.ts

29ffa67

docs: Add JSDoc documentation to orders-types.ts

2fec8d2

docs: Add JSDoc documentation to payments-types.ts

8773e38

docs: Add JSDoc documentation to perpetuals-types.ts

411928b

docs: Add JSDoc documentation to portfolios-types.ts

8d8c506

docs: Add JSDoc documentation to products-types.ts

b85d49e

docs: Add JSDoc documentation to request-types.ts

97efb58

docs: Add JSDoc documentation to constants.ts

a03a359

docs: Add JSDoc documentation to index.ts

68399f6

docs: Add JSDoc documentation to advancedTrade.ts

5b26e2e

docs: Add JSDoc documentation to commerce.ts

607d172

docs: Add JSDoc documentation to massPayments.ts

c4f519f

docs: Add JSDoc documentation to tokenContract.ts

d745997

docs: Add JSDoc documentation to trade.ts

5f2d296

docs: Add JSDoc documentation to webhooks.ts

6bf96d4

docs: Add JSDoc documentation to types.ts

52c7118

docs: Add JSDoc documentation to utils.ts

f4f4e60

docs: Add JSDoc documentation to tsup.config.ts

617255a

docs: Add JSDoc documentation to crossSpaceCall.ts

c2512c0

docs: Add JSDoc documentation to erc20.ts

25e4622

docs: Add JSDoc documentation to meme.ts

a447040

docs: Add JSDoc documentation to bridgeTransfer.ts

ba750e0

docs: Add JSDoc documentation to confiPump.ts

7b61579

docs: Add JSDoc documentation to transfer.ts

fc313d8

docs: Add JSDoc documentation to index.ts

ffc8ef6

docs: Add JSDoc documentation to types.ts

fb33bfc

docs: Add JSDoc documentation to tsup.config.ts

aa506ff

docs: Add JSDoc documentation to transfer.ts

6b67353

docs: Add JSDoc documentation to enviroment.ts

4c9ae98

madjin added 22 commits December 28, 2024 22:17

docs: Add JSDoc documentation to post.ts

872701f

docs: Add JSDoc documentation to index.ts

8780d2d

docs: Add JSDoc documentation to types.ts

fe155a5

docs: Add JSDoc documentation to tsup.config.ts

21d8656

docs: Add JSDoc documentation to constants.ts

3dd6347

docs: Add JSDoc documentation to index.ts

0d3278b

docs: Add JSDoc documentation to tsup.config.ts

00959e8

docs: Add JSDoc documentation to index.ts

55338c0

docs: Add JSDoc documentation to tsup.config.ts

16bfa26

docs: Add JSDoc documentation to client.ts

50785aa

docs: Add JSDoc documentation to index.ts

15347a5

docs: Add JSDoc documentation to message.handler.ts

fb6bcf2

docs: Add JSDoc documentation to webhook.handler.ts

1ecf33b

docs: Add JSDoc documentation to index.ts

7920b8f

docs: Add JSDoc documentation to types.ts

b44613b

docs: Add JSDoc documentation to index.ts

20aa102

docs: Add JSDoc documentation to validators.ts

f509bfd

docs: Add JSDoc documentation to tsup.config.ts

8bb380c

docs: Add JSDoc documentation to transfer.ts

85b019d

docs: Add JSDoc documentation to enviroment.ts

875be5b

docs: Add JSDoc documentation to index.ts

5698078

docs: Add JSDoc documentation to tsup.config.ts

9808603

madjin added automated-pr documentation Improvements or additions to documentation labels Dec 29, 2024

madjin requested review from lalalune and odilitime December 29, 2024 03:17

fix jsdocs comments

4a6be4e

luduvigo reviewed Dec 30, 2024

View reviewed changes

odilitime marked this pull request as draft December 30, 2024 18:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add JSDoc documentation for repository #1551

Add JSDoc documentation for repository #1551

madjin commented Dec 29, 2024

odilitime commented Dec 29, 2024

luduvigo left a comment

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

luduvigo Dec 30, 2024

Add JSDoc documentation for repository #1551

Are you sure you want to change the base?

Add JSDoc documentation for repository #1551

Conversation

madjin commented Dec 29, 2024

Summary of Changes

Summary of Modified Files

Instructions for Reviewers

odilitime commented Dec 29, 2024

luduvigo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment