Skip to content

Commit 1f794fb

Browse files
committed
fix(docs): correct JSDoc param syntax to fix build issues
- Updated JSDoc `@param` annotations in `ticketimport.js` to use `tickets[].field` syntax, ensuring compatibility with VitePress. - Added `.temp` directory to `.gitignore` to prevent unnecessary files from being tracked. - These changes resolve the issue where the docs build was failing due to improper parsing of the `@param` block.
1 parent 8248632 commit 1f794fb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jspm_packages/
4747
# vitepress build/dev output
4848
docs/.vitepress/dist
4949
docs/.vitepress/cache
50+
docs/.vitepress/.temp
5051
docs/api/
5152
docs/code/
5253

src/clients/core/ticketimport.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ class TicketImport extends Client {
5858
/**
5959
* Bulk imports multiple tickets into Zendesk.
6060
* @param {Array<object>} tickets - An array containing ticket data to be imported. Each ticket should include the following fields:
61-
* - `assignee_id` (number): The ID of the user to assign this ticket to.
62-
* - `comments` (Array<Object>): Array of comments associated with the ticket.
63-
* - `description` (string): The description of the ticket.
64-
* - `requester_id` (number): The ID of the user requesting the ticket.
65-
* - `subject` (string): The subject of the ticket.
66-
* - `tags` (Array<string>): Array of tags associated with the ticket.
61+
* @param {number} tickets[].assignee_id - The ID of the user to assign this ticket to.
62+
* @param {Array<object>} tickets[].comments - Array of comments associated with the ticket.
63+
* @param {string} tickets[].description - The description of the ticket.
64+
* @param {number} tickets[].requester_id - The ID of the user requesting the ticket.
65+
* @param {string} tickets[].subject - The subject of the ticket.
66+
* @param {Array<string>} tickets[].tags - Array of tags associated with the ticket.
6767
* **Note**: While these fields are required for each ticket object, they are not directly accessed within this function. The entire array of tickets is passed to the Zendesk API.
6868
* @returns {Promise<{response: object, result: object}>} The response from the Zendesk API, including a job status object.
6969
* @throws {Error} Throws an error if the request to the Zendesk API fails.

0 commit comments

Comments
 (0)