Skip to content

Conversation

@hemidactylus
Copy link
Collaborator

Addresses #161.

@hemidactylus hemidactylus marked this pull request as ready for review October 15, 2025 14:16
@hemidactylus hemidactylus requested a review from Copilot October 15, 2025 14:16
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR converts docstring markup from reStructuredText (RST) to Markdown format across multiple files in the langchain-astradb library. The changes improve documentation consistency and readability by using more modern Markdown syntax.

Key changes:

  • Replaced RST code blocks (.. code-block::) with Markdown code fences (```language)
  • Converted RST inline code (`text`) to Markdown inline code (`text`)
  • Changed RST hyperlinks (\text `_) to Markdown links (text`)

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
libs/astradb/langchain_astradb/vectorstores.py Converted extensive RST formatting to Markdown in docstrings, including code examples, inline code references, and hyperlinks
libs/astradb/langchain_astradb/utils/vector_store_codecs.py Updated inline code references from RST to Markdown
libs/astradb/langchain_astradb/utils/astradb.py Updated inline code references from RST to Markdown
libs/astradb/langchain_astradb/storage.py Converted JSON code blocks and inline code from RST to Markdown
libs/astradb/langchain_astradb/document_loaders.py Updated inline code reference from RST to Markdown
libs/astradb/langchain_astradb/chat_message_histories.py Updated inline code reference from RST to Markdown
libs/astradb/langchain_astradb/cache.py Updated inline code references from RST to Markdown

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@hemidactylus hemidactylus requested a review from Copilot October 15, 2025 15:04
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@hemidactylus hemidactylus merged commit 662fe43 into main Oct 15, 2025
15 checks passed
@hemidactylus hemidactylus deleted the SL-issue-161-markdown-docstrings branch October 15, 2025 16:09
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.

3 participants