From cf792891f1fc4643dc47001e1002bb6c68e9b7a0 Mon Sep 17 00:00:00 2001 From: Leonid Ganeline Date: Thu, 24 Aug 2023 09:01:52 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20docs:=20compact=20api=20referenc?= =?UTF-8?q?e=20(#8651)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated design of the "API Reference" text Here is an example of the current format: ![image](https://github.com/langchain-ai/langchain/assets/2256422/8727f2ba-1b69-497f-aa07-07f939b6da3b) It changed to `langchain.retrievers.ElasticSearchBM25Retriever` format. The same format as it is in the API Reference Toc. It also resembles code: `from langchain.retrievers import ElasticSearchBM25Retriever` (namespace THEN class_name) Current format is `ElasticSearchBM25Retriever from langchain.retrievers` (class_name THEN namespace) This change is in line with other formats and improves readability. @baskaryan --- docs/docs_skeleton/src/theme/CodeBlock/index.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs_skeleton/src/theme/CodeBlock/index.js b/docs/docs_skeleton/src/theme/CodeBlock/index.js index e97503cd83..84da0b86ef 100644 --- a/docs/docs_skeleton/src/theme/CodeBlock/index.js +++ b/docs/docs_skeleton/src/theme/CodeBlock/index.js @@ -24,8 +24,7 @@ function Imports({ imports }) {
  • {imported} - {" "} - from {source} +
    • ))}