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: API Reference builder bug fix #17890

Conversation

leo-gan
Copy link
Collaborator

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

Issue in the API Reference:
If the Classes of Functions section is empty, it still shown in API Reference. Here is an example where Functions table is empty but still presented.
It happens only if this section has only the "private" members (with names started with '_'). Those members are not shown but the whole member section (empty) is shown.

Copy link

vercel bot commented Feb 21, 2024

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

Name Status Preview Comments Updated (UTC)
langchain ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 21, 2024 8:48pm

@leo-gan leo-gan marked this pull request as ready for review February 21, 2024 20:46
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. 🤖:bug Related to a bug, vulnerability, unexpected error with an existing feature labels Feb 21, 2024
@leo-gan leo-gan added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Feb 21, 2024
@dosubot dosubot bot added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Feb 21, 2024
@eyurtsev eyurtsev merged commit 6f5b7b5 into langchain-ai:master Feb 21, 2024
7 checks passed
@leo-gan
Copy link
Collaborator Author

leo-gan commented Feb 21, 2024

@eyurtsev Thanks! Eugene, could you, please, build the API Ref to check if this fix works? I can not do this locally now (in process of debugging the problem with this build)

@leo-gan leo-gan deleted the api-references-only-public-elements-bug-fix branch February 21, 2024 21:02
k8si pushed a commit to Mozilla-Ocho/langchain that referenced this pull request Feb 22, 2024
Issue in the API Reference:
If the `Classes` of `Functions` section is empty, it still shown in API
Reference. Here is an
[example](https://api.python.langchain.com/en/latest/core_api_reference.html#module-langchain_core.agents)
where `Functions` table is empty but still presented.
It happens only if this section has only the "private" members (with
names started with '_'). Those members are not shown but the whole
member section (empty) is shown.
al1p pushed a commit to al1p/langchain that referenced this pull request Feb 27, 2024
Issue in the API Reference:
If the `Classes` of `Functions` section is empty, it still shown in API
Reference. Here is an
[example](https://api.python.langchain.com/en/latest/core_api_reference.html#module-langchain_core.agents)
where `Functions` table is empty but still presented.
It happens only if this section has only the "private" members (with
names started with '_'). Those members are not shown but the whole
member section (empty) is shown.
haydeniw pushed a commit to haydeniw/langchain that referenced this pull request Feb 27, 2024
Issue in the API Reference:
If the `Classes` of `Functions` section is empty, it still shown in API
Reference. Here is an
[example](https://api.python.langchain.com/en/latest/core_api_reference.html#module-langchain_core.agents)
where `Functions` table is empty but still presented.
It happens only if this section has only the "private" members (with
names started with '_'). Those members are not shown but the whole
member section (empty) is shown.
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:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants