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

Adding new docs for usage #1288

Draft
wants to merge 1 commit into
base: canary
Choose a base branch
from
Draft

Adding new docs for usage #1288

wants to merge 1 commit into from

Conversation

hellovai
Copy link
Contributor

@hellovai hellovai commented Jan 3, 2025

Important

Adds new documentation for proposed BAML client features id, Logger, and with_options, and updates navigation in docs.yml.

  • New Documentation:
    • Adds id.mdx to document the id feature for tracking function calls.
    • Adds logger.mdx to document the Logger class for inspecting function call states.
    • Adds with_options.mdx to document the with_options function for client configuration.
  • Proposal Details:
    • id, Logger, and with_options are in the proposal stage and not yet available.
    • Features aim to improve observability, debugging, and configuration management.
  • Navigation Update:
    • Updates docs.yml to include new documentation pages under baml_client section.

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

Copy link

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

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.

❌ Changes requested. Reviewed everything up to 12d0e7a in 1 minute and 57 seconds

More details
  • Looked at 1138 lines of code in 5 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. fern/03-reference/baml_client/id.mdx:114
  • Draft comment:
    The Ruby example for parallel execution incorrectly uses await, which is not valid in Ruby. It should use the Async block correctly without await.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. fern/03-reference/baml_client/with_options.mdx:206
  • Draft comment:
    The Ruby example for parallel execution incorrectly uses await, which is not valid in Ruby. It should use the Async block correctly without await.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_rU5xjXUoAAe6QkUC


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

console.log(res)

// This is guaranteed to be set by the function
assert(logger.last)
Copy link
Contributor

Choose a reason for hiding this comment

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

The TypeScript example uses assert(logger.last), which is not a valid TypeScript assertion. Consider using a proper check or TypeScript assertion instead.

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