Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 1, 2025

  • Understand the feedback: Move JSDoc tags (@see, @param, @returns, @example) to the end of comments, with descriptions above them
  • Fix JSDoc comments in src/resource_clients/actor_collection.ts - list() method
  • Fix JSDoc comments in src/apify_client.ts - all affected methods
  • Fix JSDoc comments in src/resource_clients/actor.ts - start(), call(), build(), lastRun() methods
  • Fix JSDoc comments in src/resource_clients/run.ts - all affected methods
  • Fix JSDoc comments in src/resource_clients/key_value_store.ts - all affected methods
  • Fix JSDoc comments in all collection files - list() methods
  • Verify build passes
  • Reverted incorrectly introduced @example tags to inline code blocks (per reviewer feedback)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: B4nan <615580+B4nan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 1, 2025

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • googlechromelabs.github.io
    • Triggering command: /usr/local/bin/node node install.mjs (dns block)
  • https://storage.googleapis.com/chrome-for-testing-public/142.0.7444.175/linux64/chrome-linux64.zip
    • Triggering command: /usr/local/bin/node node install.mjs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Fix JSDoc formatting in API reference generation Fix JSDoc tag ordering for correct TypeDoc rendering Dec 1, 2025
Copilot finished work on behalf of B4nan December 1, 2025 19:31
Copilot AI requested a review from B4nan December 1, 2025 19:31
@B4nan
Copy link
Member

B4nan commented Dec 1, 2025

@copilot Place @example tags at the end everywhere.

Co-authored-by: B4nan <615580+B4nan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 1, 2025

@copilot Place @example tags at the end everywhere.

Done in b0b9aed. Moved all @example tags to the end of the JSDoc comments, after @param, @returns, and @see tags.

Copilot finished work on behalf of B4nan December 1, 2025 19:48
@B4nan
Copy link
Member

B4nan commented Dec 1, 2025

@copilot there are few places where you converted existing code blocks to @example tags, revert those changes, do not introduce new @example tags

Co-authored-by: B4nan <615580+B4nan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 1, 2025

@copilot there are few places where you converted existing code blocks to @example tags, revert those changes, do not introduce new @example tags

Done in 0eb8836. Reverted the inline code blocks in all collection list() methods - they now use the original format with code blocks embedded in the description text instead of @example tags.

Copilot finished work on behalf of B4nan December 1, 2025 19:59
@B4nan B4nan marked this pull request as ready for review December 1, 2025 20:15
@B4nan B4nan merged commit c1214ce into feat/jsdocs Dec 1, 2025
12 checks passed
@B4nan B4nan deleted the copilot/sub-pr-797 branch December 1, 2025 20:24
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