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: remove no longer used docs #461

Merged
merged 2 commits into from
Nov 16, 2024
Merged

fix: remove no longer used docs #461

merged 2 commits into from
Nov 16, 2024

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented Nov 16, 2024

PR Type

Documentation


Description

  • Removed documentation for several modules and classes under semantic_router.splitters and semantic_router.text.
  • Deleted references to unused modules and classes in the semantic_router documentation.
  • Cleaned up documentation files by removing obsolete content.

Changes walkthrough 📝

Relevant files
Documentation
16 files
semantic_router.rst
Remove unused module references from semantic_router.rst 

docs/source/_autosummary/semantic_router.rst

  • Removed references to semantic_router.splitters
  • Removed references to semantic_router.text
  • +0/-2     
    semantic_router.splitters.base.BaseSplitter.rst
    Remove BaseSplitter class documentation                                   

    docs/source/_autosummary/semantic_router.splitters.base.BaseSplitter.rst

    • Deleted the entire documentation for BaseSplitter class
    +0/-45   
    semantic_router.splitters.base.rst
    Remove base module documentation                                                 

    docs/source/_autosummary/semantic_router.splitters.base.rst

  • Deleted the entire documentation for semantic_router.splitters.base
    module
  • +0/-31   
    semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst
    Remove ConsecutiveSimSplitter class documentation               

    docs/source/_autosummary/semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst

  • Deleted the entire documentation for ConsecutiveSimSplitter class
  • +0/-45   
    semantic_router.splitters.consecutive_sim.rst
    Remove consecutive_sim module documentation                           

    docs/source/_autosummary/semantic_router.splitters.consecutive_sim.rst

  • Deleted the entire documentation for
    semantic_router.splitters.consecutive_sim module
  • +0/-31   
    semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst
    Remove CumulativeSimSplitter class documentation                 

    docs/source/_autosummary/semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst

    • Deleted the entire documentation for CumulativeSimSplitter class
    +0/-45   
    semantic_router.splitters.cumulative_sim.rst
    Remove cumulative_sim module documentation                             

    docs/source/_autosummary/semantic_router.splitters.cumulative_sim.rst

  • Deleted the entire documentation for
    semantic_router.splitters.cumulative_sim module
  • +0/-31   
    semantic_router.splitters.rolling_window.RollingWindowSplitter.rst
    Remove RollingWindowSplitter class documentation                 

    docs/source/_autosummary/semantic_router.splitters.rolling_window.RollingWindowSplitter.rst

    • Deleted the entire documentation for RollingWindowSplitter class
    +0/-47   
    semantic_router.splitters.rolling_window.SplitStatistics.rst
    Remove SplitStatistics class documentation                             

    docs/source/_autosummary/semantic_router.splitters.rolling_window.SplitStatistics.rst

    • Deleted the entire documentation for SplitStatistics class
    +0/-38   
    semantic_router.splitters.rolling_window.rst
    Remove rolling_window module documentation                             

    docs/source/_autosummary/semantic_router.splitters.rolling_window.rst

  • Deleted the entire documentation for
    semantic_router.splitters.rolling_window module
  • +0/-32   
    semantic_router.splitters.rst
    Remove splitters module documentation                                       

    docs/source/_autosummary/semantic_router.splitters.rst

  • Deleted the entire documentation for semantic_router.splitters module
  • +0/-36   
    semantic_router.splitters.utils.rst
    Remove utils module documentation                                               

    docs/source/_autosummary/semantic_router.splitters.utils.rst

  • Deleted the entire documentation for semantic_router.splitters.utils
    module
  • +0/-31   
    semantic_router.splitters.utils.split_to_sentences.rst
    Remove split_to_sentences function documentation                 

    docs/source/_autosummary/semantic_router.splitters.utils.split_to_sentences.rst

    • Deleted the entire documentation for split_to_sentences function
    +0/-6     
    semantic_router.splitters.utils.tiktoken_length.rst
    Remove tiktoken_length function documentation                       

    docs/source/_autosummary/semantic_router.splitters.utils.tiktoken_length.rst

    • Deleted the entire documentation for tiktoken_length function
    +0/-6     
    semantic_router.text.Conversation.rst
    Remove Conversation class documentation                                   

    docs/source/_autosummary/semantic_router.text.Conversation.rst

    • Deleted the entire documentation for Conversation class
    +0/-52   
    semantic_router.text.rst
    Remove text module documentation                                                 

    docs/source/_autosummary/semantic_router.text.rst

    • Deleted the entire documentation for semantic_router.text module
    +0/-31   

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

    Copy link

    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

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @jamescalam jamescalam merged commit 06e3a6a into main Nov 16, 2024
    6 checks passed
    @jamescalam jamescalam deleted the james/docs-cleanup branch November 16, 2024 16:53
    Copy link

    codecov bot commented Nov 16, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 72.09%. Comparing base (342d343) to head (984e2b8).
    Report is 3 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main     #461   +/-   ##
    =======================================
      Coverage   72.09%   72.09%           
    =======================================
      Files          39       39           
      Lines        3290     3290           
    =======================================
      Hits         2372     2372           
      Misses        918      918           

    ☔ 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