From e8531769f793b016da99db2a993fd175a6f08f2f Mon Sep 17 00:00:00 2001 From: Harrison Chase Date: Tue, 4 Jul 2023 16:31:29 -0700 Subject: [PATCH] improve docstring of doc formatting (#7162) so it shows up nice --- langchain/schema/prompt_template.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/langchain/schema/prompt_template.py b/langchain/schema/prompt_template.py index 7b340887eb..a7d17ef084 100644 --- a/langchain/schema/prompt_template.py +++ b/langchain/schema/prompt_template.py @@ -164,12 +164,13 @@ def format_document(doc: Document, prompt: BasePromptTemplate) -> str: Example: .. code-block:: python - from langchain.schema import Document - from langchain.prompts import PromptTemplate - doc = Document(page_content="This is a joke", metadata={"page": "1"}) - prompt = PromptTemplate.from_template("Page {page}: {page_content}") - format_document(doc, prompt) - >>> "Page 1: This is a joke" + + from langchain.schema import Document + from langchain.prompts import PromptTemplate + doc = Document(page_content="This is a joke", metadata={"page": "1"}) + prompt = PromptTemplate.from_template("Page {page}: {page_content}") + format_document(doc, prompt) + >>> "Page 1: This is a joke" """ base_info = {"page_content": doc.page_content, **doc.metadata} missing_metadata = set(prompt.input_variables).difference(base_info)