Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for recursive type aliases #1294

Merged
merged 1 commit into from
Jan 6, 2025

Conversation

antoniosarosi
Copy link
Contributor

@antoniosarosi antoniosarosi commented Jan 6, 2025

Important

Adds documentation for recursive type aliases in BAML, including examples and limitations.

  • Documentation:
    • Adds section on recursive type aliases in types.mdx.
    • Explains support for recursive type aliases through map or list containers.
    • Provides examples of valid recursive type aliases and invalid self-referential aliases.

This description was created by Ellipsis for 4900023. It will automatically update as commits are pushed.

Copy link

vercel bot commented Jan 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
baml ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 9:32pm

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 4900023 in 9 seconds

More details
  • Looked at 44 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. fern/03-reference/baml/types.mdx:379
  • Draft comment:
    The phrase "just like in TypeScript" might be misleading as TypeScript does not restrict recursive type aliases to only map or list containers. Consider rephrasing to avoid confusion.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR adds documentation for recursive type aliases, which is a new feature. The examples provided are clear, but there is a minor inconsistency in the description of recursive type aliases.

Workflow ID: wflow_7zdmIUpyP9TkISDT


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@antoniosarosi antoniosarosi added this pull request to the merge queue Jan 6, 2025
Merged via the queue into canary with commit 43a0007 Jan 6, 2025
11 checks passed
@antoniosarosi antoniosarosi deleted the antonio/recursive-type-aliases-docs branch January 6, 2025 21:33
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