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.

Sign up for GitHub

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

Jump to bottom

DOC: Typo in “PromptTemplate” documentation (“evens” should be “events”) #27107

Closed
2 tasks done
adityash97 opened this issue Oct 4, 2024 · 0 comments
Closed
2 tasks done

DOC: Typo in “PromptTemplate” documentation (“evens” should be “events”) #27107

adityash97 opened this issue Oct 4, 2024 · 0 comments
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@adityash97
Copy link
Contributor

URL

https://python.langchain.com/api_reference/core/prompts/langchain_core.prompts.prompt.PromptTemplate.html

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

Issue with current documentation:

There is a typo in the documentation for the async astream_events method in the LangChain docs.

In the section where the table is introduced, the word “evens” is incorrectly used instead of “events.” The sentence reads:

“Below is a table that illustrates some evens that might be emitted by various chains.”

It should be corrected to:

“Below is a table that illustrates some events that might be emitted by various chains.”

The typo appears just before the table showing possible events emitted by chains, under the

“Generate a stream of events” section.

Screenshot :
Screenshot 2024-10-04 at 9 20 16 PM

Idea or request for content:

No response
@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Oct 4, 2024
adityash97 added a commit to adityash97/langchain that referenced this issue Oct 4, 2024
@adityash97
fix: Correct typo in 'PromptTemplate' documentation
e52c60d 
This commit addresses a typographical error in the documentation for the async astream_events method. The word 'evens' was incorrectly used in the introductory sentence for the reference table, which could lead to confusion for users.\n\n### Changes Made:\n- Corrected 'Below is a table that illustrates some evens that might be emitted by various chains.' to 'Below is a table that illustrates some events that might be emitted by various chains.'\n\nThis enhancement improves the clarity of the documentation and ensures accurate terminology is used throughout the reference material.\n\nIssue Reference: langchain-ai#27107
@adityash97 adityash97 mentioned this issue Oct 4, 2024
Merged
eyurtsev pushed a commit that referenced this issue Oct 7, 2024
@adityash97
core[patch]: correct typo doc-string for astream_events method (#27108)
f70650f 
This commit addresses a typographical error in the documentation for the
async astream_events method. The word 'evens' was incorrectly used in
the introductory sentence for the reference table, which could lead to
confusion for users.\n\n### Changes Made:\n- Corrected 'Below is a table
that illustrates some evens that might be emitted by various chains.' to
'Below is a table that illustrates some events that might be emitted by
various chains.'\n\nThis enhancement improves the clarity of the
documentation and ensures accurate terminology is used throughout the
reference material.\n\nIssue Reference: #27107
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adityash97