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

community: Fix links in GraphVectorStore pydoc #25959

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

cbornet
Copy link
Collaborator

@cbornet cbornet commented Sep 3, 2024

No description provided.

Copy link

vercel bot commented Sep 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langchain ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 11:16pm

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. community Related to langchain-community Ɑ: vector store Related to vector store module 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Sep 3, 2024
Example:

.. code-block:: python
Example::
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Python is the default code-block language. So the syntax can be simplified.

element = element.a.code.span
# Get the text content of the element
content = element.get_text()
if element.a.code:
Copy link
Collaborator Author

@cbornet cbornet Sep 3, 2024

Choose a reason for hiding this comment

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

⚠️ Pydoc with multiple levels of headings create toc-h3 elements

@cbornet cbornet changed the title docs: Add TOC to GraphVectorStore doc community: Add TOC to GraphVectorStore doc Sep 3, 2024
@efriis efriis self-assigned this Sep 3, 2024
@cbornet cbornet changed the title community: Add TOC to GraphVectorStore doc community: Fix links in GraphVectorStore pydoc Sep 4, 2024
@cbornet cbornet force-pushed the improve-gvs-doc branch 2 times, most recently from 4deb900 to b0af6ba Compare September 9, 2024 14:59
@cbornet
Copy link
Collaborator Author

cbornet commented Sep 18, 2024

Rebased.
Can this be reviewed 🙏 ?
Only easy to review docstring.

Copy link
Member

@efriis efriis left a comment

Choose a reason for hiding this comment

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

I don't think the api reference formatter change does anything different aside from increasing the cases where the job could fail. Thoughts on reverting that and just doing the docstring change?

@cbornet
Copy link
Collaborator Author

cbornet commented Sep 20, 2024

I reverted the changes on the ref formatter.
Can you take a look again ?

@efriis efriis enabled auto-merge (squash) September 20, 2024 23:16
@efriis efriis merged commit 58f339a into langchain-ai:master Sep 20, 2024
31 checks passed
sfc-gh-nmoiseyev pushed a commit to sfc-gh-nmoiseyev/langchain that referenced this pull request Sep 21, 2024
Co-authored-by: Erick Friis <erick@langchain.dev>
@cbornet cbornet deleted the improve-gvs-doc branch September 21, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Related to langchain-community 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder size:M This PR changes 30-99 lines, ignoring generated files. Ɑ: vector store Related to vector store module
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants