doc: fix typo in example TS snippet

[dilawar]

Fix typo in typescript function

---

Important

Fixes syntax error in TypeScript snippet in introduction.mdx by replacing : with { in create_joke() function.

• Fix:
  • Corrects syntax error in TypeScript snippet in introduction.mdx by replacing : with { in create_joke() function.

^{This description was created by for d1e94cc. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• Documentation
  • Corrected a TypeScript example in the Introduction to use proper function body syntax and accurate language tagging, improving accuracy and copy‑paste usability.
  • Ensured examples render clearly and align with current best practices for code snippets.
  • Confirmed the Python example remains unchanged.
  • Clarified wording to reduce confusion for readers following the quickstart.

[coderabbitai]

Walkthrough

The TypeScript snippet in openllmetry/introduction.mdx was edited: MyLLM.create_joke signature changed from async create_joke(): to async create_joke() {, enabling a function body. No other code or the Python snippet were modified.

Changes

Cohort / File(s)	Summary
Docs snippet (TypeScript) openllmetry/introduction.mdx	Changed TypeScript example method declaration from async create_joke(): to async create_joke() {. No other content or the Python snippet changed.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Reader as Docs Reader
    participant File as `introduction.mdx`
    participant Snippet as TypeScript Snippet

    Note over File,Snippet: Edit: change method signature to include body
    Reader->>File: Open docs
    File->>Snippet: Render TypeScript example
    Snippet->>Reader: Shows `async create_joke() { ... }`
    Note right of Reader: Snippet now contains a function body token

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title “doc: fix typo in example TS snippet” is concise and accurately reflects the primary change of correcting a syntax error in the TypeScript example, making it clear to reviewers that the documentation snippet has been fixed.
Description Check	✅ Passed	The description clearly outlines the purpose of the change, stating that it fixes a syntax error by replacing a colon with an opening brace in the TypeScript snippet and includes relevant context for the file and function.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

I twitch my nose at braces new,
A tiny hop from “:” to “{” will do.
In docs I nibble, neat and light,
Turning snippets clean and right.
Code carrots lined in tidy rows—
Onward, ship! the rabbit goes. 🥕

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d1e94cc and f2e922f.

📒 Files selected for processing (1)

• openllmetry/introduction.mdx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• openllmetry/introduction.mdx

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed everything up to d1e94cc in 42 seconds. Click for details.

• Reviewed 13 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 2 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. openllmetry/introduction.mdx:50

• Draft comment:
  Fixed TS syntax: replaced colon with '{' in function declaration.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is purely informative, stating what was changed without providing any actionable feedback or suggestions. It doesn't ask for confirmation or suggest improvements.

2. openllmetry/introduction.mdx:51

• Draft comment:
  Declare 'completion' with 'const' to prevent accidental global variable usage.
• Reason this comment was not posted:
  Comment was on unchanged code.

Workflow ID: wflow_KlMNC1upcXI3B4KD

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

openllmetry/introduction.mdx (1)

49-57: Fix invalid TS snippet: declare completion and close the class.

Currently completion is implicitly global/undefined and the class is missing its closing brace.

Apply:

 class MyLLM {
   @traceloop.workflow("joke_creation")
   async create_joke() {
-      completion = await openai.chat.completions.create({
+      const completion = await openai.chat.completions.create({
           model: "gpt-3.5-turbo",
           messages: [{"role": "user", "content": "Tell me a joke about opentelemetry"}],
       })
 
       return completion.choices[0].message.content
 }
+}

🧹 Nitpick comments (1)

openllmetry/introduction.mdx (1)

41-41: Use TypeScript syntax highlighting.

Change the fence to ts for proper highlighting in docs.

Example:

```ts Typescript
// ...

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: CodeRabbit UI

**Review profile**: CHILL

**Plan**: Pro

**💡 Knowledge Base configuration:**

- Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between fae41a25691f2d1fb6a69f0c15023cb78ead73ad and d1e94cc484673126dc930a020ac8af5c88880d08.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `openllmetry/introduction.mdx` (1 hunks)

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[nirga]

Thanks! @dilawar