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

fix: missing auto_sync in intro doc #476

Merged
merged 2 commits into from
Dec 3, 2024
Merged

fix: missing auto_sync in intro doc #476

merged 2 commits into from
Dec 3, 2024

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented Dec 3, 2024

PR Type

documentation


Description

  • Updated the introductory documentation in docs/00-introduction.ipynb to include the missing auto_sync parameter in the SemanticRouter instantiation example.
  • Ensures the example code is accurate and aligns with the expected usage of the SemanticRouter class.

Changes walkthrough 📝

Relevant files
Documentation
00-introduction.ipynb
Add `auto_sync` parameter to `SemanticRouter` example in introduction

docs/00-introduction.ipynb

  • Added the auto_sync parameter to the SemanticRouter instantiation
    example.
  • Updated the introductory documentation to include the missing
    parameter for clarity.
  • +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    github-actions bot commented Dec 3, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    github-actions bot commented Dec 3, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    docs/00-introduction.ipynb Outdated Show resolved Hide resolved
    @jamescalam jamescalam merged commit a0f6192 into main Dec 3, 2024
    7 checks passed
    @jamescalam jamescalam deleted the james/doc-sync-fix branch December 3, 2024 13:50
    Copy link

    codecov bot commented Dec 3, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 73.51%. Comparing base (97b15ba) to head (b34a955).
    Report is 4 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main     #476   +/-   ##
    =======================================
      Coverage   73.51%   73.51%           
    =======================================
      Files          43       43           
      Lines        3545     3545           
    =======================================
      Hits         2606     2606           
      Misses        939      939           

    ☔ View full report in Codecov by Sentry.
    📢 Have feedback on the report? Share it here.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant