-
Notifications
You must be signed in to change notification settings - Fork 13
Markdown for docstrings #162
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
Conversation
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.
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.
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.
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.
Addresses #161.