Skip to content

Conversation

@mdrxy
Copy link
Contributor

@mdrxy mdrxy commented Oct 9, 2025

Claude Code

  I've resolved all three warnings:

  1. Line 3958 - Removed incorrect 'texts' parameter 
  (vectorstores.py:3958)

  The from_documents method's docstring incorrectly
  documented a texts parameter that doesn't exist in the
  function signature. I removed this line since the method
  only accepts documents, embedding, and **kwargs.

  2. Line 4008 - Fixed malformed Args section 
  (vectorstores.py:4008)

  The afrom_documents method had a malformed Args section
  that said "Args: see :meth:afrom_texts, except here you
  have to supply documents in place of texts and metadatas."
  This wasn't properly formatted for griffe to parse.

  I replaced it with a proper Google-style docstring that
  explicitly documents each parameter:
  - documents: a list of Document objects for insertion in
  the store
  - embedding: the embedding function to use in the store
  - **kwargs: arguments passed to aadd_texts and/or the
  constructor

  Both methods now have consistent, properly formatted
  docstrings that griffe can parse without warnings. The lint
   check confirms the warnings are resolved.

@mdrxy mdrxy requested a review from cbornet October 9, 2025 21:54
@cbornet
Copy link
Collaborator

cbornet commented Oct 10, 2025

@mdrxy IIUC this fixes Griffe warnings and we will also have to convert reST to markdown (code blocks, links, etc...) in other PRs ?

@mdrxy
Copy link
Contributor Author

mdrxy commented Oct 10, 2025

@cbornet yep - I'll let you merge this since I don't have time to dig into the CI issues

@hemidactylus
Copy link
Collaborator

The CI failures were because two PRs at the same time triggered their integration tests together and we got resource contention on one database. Re-running at a quieter time, now it's all green. Merging.

@hemidactylus hemidactylus merged commit 8d4faad into main Oct 14, 2025
25 of 27 checks passed
@hemidactylus hemidactylus deleted the mdrxy/fix-griffe-warnings branch October 14, 2025 23:35
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.

4 participants