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

DOC: The arguments used in the function declaration differ from those written in the function description #28966

Open
2 tasks done
skaghzz opened this issue Dec 30, 2024 · 0 comments
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@skaghzz
Copy link

skaghzz commented Dec 30, 2024

URL

https://python.langchain.com/api_reference/core/prompts/langchain_core.prompts.base.BasePromptTemplate.html#langchain_core.prompts.base.BasePromptTemplate.partial

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:

class : BasePromptTemplate
function : partial
Issue : The arguments used in the function declaration differ from those written in the function description

    def partial(self, **kwargs: Union[str, Callable[[], str]]) -> BasePromptTemplate:
        """Return a partial of the prompt template.

        Args:
            kwargs: Union[str, Callable[[], str], partial variables to set.

        Returns:
            BasePromptTemplate: A partial of the prompt template.
        """

Source Code : https://github.com/langchain-ai/langchain/blob/master/libs/core/langchain_core/prompts/base.py#L267 #

Idea or request for content:

add ']' at the end of Union

kwargs: Union[str, Callable[[], str], partial variables to set.
=> kwargs: Union[str, Callable[[], str]], partial variables to set.

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Dec 30, 2024
ccurme pushed a commit that referenced this issue Jan 2, 2025
…Template` (#28969)

- **Description:** Very small change in Docstring for
`BasePromptTemplate`
- **Issue:** #28966
pprados pushed a commit to pprados/langchain that referenced this issue Jan 3, 2025
…Template` (langchain-ai#28969)

- **Description:** Very small change in Docstring for
`BasePromptTemplate`
- **Issue:** langchain-ai#28966
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

No branches or pull requests

1 participant