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

Docstrings: Module descriptions #8262

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Docstrings: Module descriptions #8262

merged 2 commits into from
Aug 1, 2023

Conversation

leo-gan
Copy link
Collaborator

@leo-gan leo-gan commented Jul 26, 2023

Added/changed the module descriptions (the firs-line docstrings in the __init__ files).
Added class hierarchy info.
@baskaryan

@vercel
Copy link

vercel bot commented Jul 26, 2023

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

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
langchain ⬜️ Ignored (Inspect) Aug 1, 2023 4:59am
langchain-deprecated ⬜️ Ignored (Inspect) Aug 1, 2023 4:59am

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Jul 26, 2023
@leo-gan leo-gan marked this pull request as ready for review July 26, 2023 01:46
@leo-gan leo-gan changed the title Module descriptions Docstrings: Module descriptions Jul 26, 2023
@leo-gan leo-gan marked this pull request as draft July 26, 2023 23:45
@leo-gan leo-gan marked this pull request as ready for review July 27, 2023 04:30
@leo-gan leo-gan marked this pull request as draft July 27, 2023 16:46
@leo-gan leo-gan marked this pull request as ready for review July 27, 2023 21:38
@leo-gan leo-gan requested a review from baskaryan July 28, 2023 18:21
@leo-gan
Copy link
Collaborator Author

leo-gan commented Jul 31, 2023

@baskaryan Do you think, option #2 or #4 (from ^) makes naming convention clear? Please, let me know.

@leo-gan leo-gan marked this pull request as draft August 1, 2023 00:10
@leo-gan leo-gan marked this pull request as ready for review August 1, 2023 05:08
@baskaryan
Copy link
Collaborator

much clearer, thanks @leo-gan!!

@baskaryan baskaryan merged commit ed9a0f8 into langchain-ai:master Aug 1, 2023
22 checks passed
@leo-gan leo-gan deleted the module_descriptions branch August 1, 2023 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants