Skip to content

Conversation

samchon
Copy link
Owner

@samchon samchon commented Jul 10, 2025

Some description.

@title some title

Also, this strategy would be adjusted to the typia too. typia will no more define IJsonSchema.title from description comment. It will compose IJsonSchema.title only by @title tag.

export interface Something {
  /**
   * The first line is not title.
   */
  first: string;

  /**
   * The title only comes from JSDocTag like below.
   *
   * @title this is the title
   */
  second: number;
}

```txt
Some description.

@title some title
```

Also, this strategy would be adjusted to the `typia` too. `typia` will no more define `IJsonSchema.title` from description comment. It will compose `IJsonSchema.title` only by `@title` tag.

```typescript
export interface Something {
  /**
   * The first line is not title.
   */
  first: string;

  /**
   * The title only comes from JSDocTag like below.
   *
   * @title this is the title
   */
  second: number;
}
```
@samchon samchon requested a review from Copilot July 10, 2025 02:40
@samchon samchon self-assigned this Jul 10, 2025
@samchon samchon added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 10, 2025
Copy link
Contributor

@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

Updates the schema composer to derive JSON schema titles exclusively from JSDoc @title tags and bumps the package version.

  • Replace prior title/description merging logic with a simple @title tag appending.
  • Increment version in package.json to 4.5.0.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/composers/llm/GeminiSchemaComposer.ts Replace custom title-to-description logic with standardized @title tag
package.json Bump package version from 4.4.1 to 4.5.0

@samchon samchon merged commit 8a79479 into master Jul 10, 2025
4 checks passed
@samchon samchon deleted the feat/title branch July 10, 2025 03:09
@samchon samchon changed the title IChatGptSchema.title in description as JSDocTag. IGeminiSchema.title in description as JSDocTag. Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant