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 dynamic types tests #1307

Open
wants to merge 3 commits into
base: canary
Choose a base branch
from

Conversation

antoniosarosi
Copy link
Contributor

@antoniosarosi antoniosarosi commented Jan 9, 2025

Important

This PR adds documentation for testing dynamic types in BAML, detailing the use of type_builder and dynamic blocks with examples for dynamic classes and enums.

  • Documentation:
    • Adds section on testing dynamic types in testing-functions.mdx, dynamic-types.mdx, dynamic.mdx, test.mdx, and typebuilder.mdx.
    • Includes examples for dynamic classes and enums using type_builder and dynamic blocks.
    • Updates snippets/dynamic-class-test.mdx with a code example for dynamic class testing.
  • Dynamic Types:
    • Explains how to modify dynamic classes and enums in tests using type_builder and dynamic blocks.
    • Describes testing scenarios for return types and parameter types with dynamic modifications.

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

Copy link

vercel bot commented Jan 9, 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 9, 2025 10:18pm

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 6ecdca8 in 11 seconds

More details
  • Looked at 253 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. fern/01-guide/04-baml-basics/testing-functions.mdx:473
  • Draft comment:
    Add a newline at the end of the file for consistency and to follow best practices.
  • Reason this comment was not posted:
    Confidence changes required: 10%
    The documentation update is missing a newline at the end of the file, which is a common best practice.

Workflow ID: wflow_J16FeT9GsRk6yr0Y


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

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! Incremental review on 9e54097 in 18 seconds

More details
  • Looked at 406 lines of code in 5 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. fern/01-guide/04-baml-basics/testing-functions.mdx:323
  • Draft comment:
    The PR introduces a snippet inclusion for dynamic class tests, but the description lacks clarity on the changes made. Consider updating the PR description to explicitly mention the inclusion of the snippet for better clarity.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR introduces a snippet inclusion for dynamic class tests, but the description lacks clarity on the changes made. The snippet inclusion is a good practice for reusability, but the description should mention this change explicitly.

Workflow ID: wflow_2Cz6InMWMZsIjgQ5


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

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! Incremental review on babb416 in 14 seconds

More details
  • Looked at 16 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_client/typebuilder.mdx:332
  • Draft comment:
    Ensure the updated link is correct and points to the intended section. The change improves specificity, but verify the target content is relevant.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR changes a link in the documentation to point to a more specific guide. This is a minor change, but it's important to ensure the link is correct and relevant.

Workflow ID: wflow_JVLGo1gpzLsWIv0y


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

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