Skip to content

Conversation

Mister-Hope
Copy link
Member

No description provided.

@Mister-Hope Mister-Hope requested a review from Copilot June 4, 2025 08:17
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds JSDoc annotations throughout the plugin-append-date source and enhances both English and Chinese documentation pages with more detailed option descriptions.

  • Introduce JSDoc on interfaces and helper functions
  • Update README docs to clearly describe available date formats
  • Adjust default value formatting and wording consistency

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
plugins/markdown/plugin-append-date/src/node/options.ts Added JSDoc to AppendDatePluginOptions and standardized default quotes
plugins/markdown/plugin-append-date/src/node/formatDate.ts Added JSDoc for getDateString, getTimeString, and getFullDateString
plugins/markdown/plugin-append-date/src/node/checkGitPlugin.ts Added JSDoc for isGitPluginEnabled
plugins/markdown/plugin-append-date/src/node/appendDatePlugin.ts Added JSDoc (with example) for appendDatePlugin
plugins/markdown/plugin-append-date/src/node/appendDate.ts Added JSDoc for appendDateToPage
docs/zh/plugins/markdown/append-date.md Expanded Chinese docs with per-format details
docs/plugins/markdown/append-date.md Expanded English docs with per-format details and minor wording tweaks
Comments suppressed due to low confidence (6)

plugins/markdown/plugin-append-date/src/node/formatDate.ts:16

  • Add an @returns tag to JSDoc to describe the returned YYYY-MM-DD string.
/**

plugins/markdown/plugin-append-date/src/node/formatDate.ts:26

  • Add an @returns tag to JSDoc to describe the returned HH:mm:ss string.
/**

plugins/markdown/plugin-append-date/src/node/formatDate.ts:36

  • Add an @returns tag to JSDoc to describe the returned full date-time string in YYYY-MM-DD HH:mm:ss format.
/**

plugins/markdown/plugin-append-date/src/node/checkGitPlugin.ts:7

  • Add an @returns tag to JSDoc to explain that this function returns a boolean indicating if the git plugin is enabled.
/**

plugins/markdown/plugin-append-date/src/node/appendDatePlugin.ts:8

  • Add an @returns tag to JSDoc to describe the returned PluginObject from appendDatePlugin.
/**

plugins/markdown/plugin-append-date/src/node/appendDate.ts:12

  • Add an @returns tag to JSDoc to describe the returned Promise (e.g., Promise) of appendDateToPage.
/**

@Mister-Hope Mister-Hope merged commit 637780e into main Jun 4, 2025
27 checks passed
@Mister-Hope Mister-Hope deleted the append-date-refine branch June 4, 2025 08: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.

1 participant