-
Notifications
You must be signed in to change notification settings - Fork 97
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
Update BAML documentation to clarify recursive class definitions and map type in TypeBuilder #1605
base: canary
Are you sure you want to change the base?
Conversation
…map type in TypeBuilder
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this 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 7f6a43a in 1 minute and 50 seconds
More details
- Looked at
25
lines of code in2
files - Skipped
0
files when reviewing. - Skipped posting
7
drafted comments based on config settings.
1. fern/03-reference/baml_client/typebuilder.mdx:217
- Draft comment:
Ensure 'map' method documentation is consistent with API usage. - Reason this comment was not posted:
Confidence changes required:30%
<= threshold50%
None
2. fern/03-reference/baml/class.mdx:101
- Draft comment:
Remove duplicate 'be' in 'can be be recursively defined!' - Reason this comment was not posted:
Marked as duplicate.
3. fern/03-reference/baml_client/typebuilder.mdx:217
- Draft comment:
New 'map' method documentation added; consider clarifying key type constraints if needed. - Reason this comment was not posted:
Confidence changes required:33%
<= threshold50%
None
4. fern/03-reference/baml/class.mdx:101
- Draft comment:
Typo found: The sentence "classes can be be recursively defined!" contains a duplicated 'be'. Please change it to "classes can be recursively defined!". - Reason this comment was not posted:
Marked as duplicate.
5. fern/03-reference/baml_client/typebuilder.mdx:327
- Draft comment:
Typographical error: In the heading 'Creating/modyfing dynamic types with theadd_baml
method', please change 'modyfing' to 'modifying'. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
6. fern/03-reference/baml_client/typebuilder.mdx:350
- Draft comment:
Typographical error: In the code snippet, change 'dynmic enum Category' to 'dynamic enum Category'. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
7. fern/03-reference/baml_client/typebuilder.mdx:372
- Draft comment:
Typographical error: In the TypeScript code snippet, change 'dynmic enum Category' to 'dynamic enum Category'. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_peWYG9L6kHKyInL0
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.
@@ -98,7 +98,7 @@ Property names must follow these rules: | |||
- Must start with a letter | |||
- Must contain only letters, numbers, and underscores | |||
- Must be unique within the class | |||
- classes cannot be self-referential (cannot have a property of the same type as the class itself) | |||
- classes can be be recursively defined! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: Remove duplicate 'be'.
- classes can be be recursively defined! | |
- classes can be recursively defined! |
Important
Update BAML documentation to clarify recursive class definitions and add map type in TypeBuilder.
baml/class.mdx
.map
type method toTypeBuilder
inbaml_client/typebuilder.mdx
.This description was created by
for 7f6a43a. It will automatically update as commits are pushed.