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

docs: Fix bug that caused the word "Deprecated" to appear twice in doc-strings #17615

Merged
merged 3 commits into from
Feb 16, 2024

Conversation

leo-gan
Copy link
Collaborator

@leo-gan leo-gan commented Feb 16, 2024

The current issue:
Most of the deprecation descriptions in the API Reference are duplicated. For example:
[Deprecated] Chat Agent.[Deprecated] Chat Agent. for the ChatAgent class description.

NOTE: I've tested it only with new ut! I cannot build API Reference locally :(

Copy link

vercel bot commented Feb 16, 2024

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

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
langchain ⬜️ Ignored (Inspect) Visit Preview Feb 16, 2024 3:41am

Copy link
Collaborator

@eyurtsev eyurtsev left a comment

Choose a reason for hiding this comment

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

Thank you! Just minor change for the comment

@dosubot dosubot bot added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Feb 16, 2024
@eyurtsev eyurtsev changed the title docs: Depricate duplication bug docs: Fix bug that caused the word "Deprecated" to appear twice in doc-strings Feb 16, 2024
@leo-gan leo-gan marked this pull request as ready for review February 16, 2024 03:44
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Feb 16, 2024
@dosubot dosubot bot added Ɑ: agent Related to agents module 🤖:bug Related to a bug, vulnerability, unexpected error with an existing feature labels Feb 16, 2024
@leo-gan leo-gan added 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder and removed Ɑ: agent Related to agents module labels Feb 16, 2024
@eyurtsev eyurtsev merged commit 0835eba into langchain-ai:master Feb 16, 2024
76 checks passed
@leo-gan leo-gan deleted the docs-duplicate-deprecate-fix branch February 16, 2024 03:52
@leo-gan
Copy link
Collaborator Author

leo-gan commented Feb 16, 2024

@eyurtsev Thanks!

eyurtsev pushed a commit that referenced this pull request Feb 19, 2024
…ngs (#17704)

The current issue:
Several beta descriptions in the API Reference are duplicated. For
example:
`[Beta] Get a context value.[Beta] Get a context value.` for the
[ContextGet
class](https://api.python.langchain.com/en/latest/core_api_reference.html#module-langchain_core.beta)
description.

NOTE: I've tested it only with a new ut! I cannot build API Reference
locally :(
This PR related to #17615
haydeniw pushed a commit to haydeniw/langchain that referenced this pull request Feb 27, 2024
…c-strings (langchain-ai#17615)

The current issue:
Most of the deprecation descriptions are duplicated. For example:
`[Deprecated] Chat Agent.[Deprecated] Chat Agent.` for the [ChatAgent
class](https://api.python.langchain.com/en/latest/langchain_api_reference.html#classes)
description.

NOTE: I've tested it only with new ut! I cannot build API Reference
locally :(
haydeniw pushed a commit to haydeniw/langchain that referenced this pull request Feb 27, 2024
…ngs (langchain-ai#17704)

The current issue:
Several beta descriptions in the API Reference are duplicated. For
example:
`[Beta] Get a context value.[Beta] Get a context value.` for the
[ContextGet
class](https://api.python.langchain.com/en/latest/core_api_reference.html#module-langchain_core.beta)
description.

NOTE: I've tested it only with a new ut! I cannot build API Reference
locally :(
This PR related to langchain-ai#17615
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:bug Related to a bug, vulnerability, unexpected error with an existing feature 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder lgtm PR looks good. Use to confirm that a PR is ready for merging. size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants