From 7c5384dd1599a27f25b4558080d93f001c247a6f Mon Sep 17 00:00:00 2001 From: Steven Arcangeli Date: Sun, 8 Jan 2023 23:27:28 -0800 Subject: [PATCH] doc: move config opts to hide some values from autogen docs --- lua/oil/config.lua | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/lua/oil/config.lua b/lua/oil/config.lua index 0d837eb..3b96083 100644 --- a/lua/oil/config.lua +++ b/lua/oil/config.lua @@ -58,15 +58,19 @@ local default_config = { winblend = 10, }, }, - adapters = { - ["oil://"] = "files", - ["oil-ssh://"] = "ssh", - }, - -- When opening the parent of a file, substitute these url schemes - remap_schemes = { - ["scp://"] = "oil-ssh://", - ["sftp://"] = "oil-ssh://", - }, +} + +-- The adapter API hasn't really stabilized yet. We're not ready to advertise or encourage people to +-- write their own adapters, and so there's no real reason to edit these config options. For that +-- reason, I'm taking them out of the section above so they won't show up in the autogen docs. +default_config.adapters = { + ["oil://"] = "files", + ["oil-ssh://"] = "ssh", +} +-- When opening the parent of a file, substitute these url schemes +default_config.remap_schemes = { + ["scp://"] = "oil-ssh://", + ["sftp://"] = "oil-ssh://", } local M = {}