Skip to content

Out of date docs (?) #421

@metamorfoso

Description

@metamorfoso

Hi! 👋

First, thanks for making/maintaining the project. It's awesome, I love using it.

Second, apologies if this isn't the right place or format. Feel free to discard if it isn't. I'd like to contribute a fix if this is indeed an issue. I just want to make sure I understand right first.

TL;DR

I've been trying to customize the file browser a little, and doing it the way the internal docs suggest has not worked. Doing it the way the readme describes has worked 👍

Are the docs out of date? If so, I'd be willing to a raise a PR to update them :)

Details

This is the part of the docs I mean:

-- or alternatively using lua functions
    local picker = require "telescope._extensions.file_browser" -- <- this require statement
    vim.api.keymap.set("n", "<space>fb", function()
      picker.file_browser()
    end, { noremap = true })

That require statement doesn't return the actual picker for me (...attempt to call field file_browser (a nil value)).

And I see that the example given in the Usage section of the readme has a different require statement (and different way to access the keymap api):

-- Alternatively, using lua API
vim.keymap.set("n", "<space>fb", function()
	require("telescope").extensions.file_browser.file_browser()
end)

I see a lot of references in the telescope-file-browser source code itself to require("telescope._extensions"), not just the in the docs, so this seems to work fine internally 🤔

I'm quite possibly doing something wrong in my setup (I'm still a newb):

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions