Update branch name in documentation #1996
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation incorrectly points to the `stable` branch in the example. However, if you look at the lazy.nvim list of branches, you won't find a `stable` branch[1]. This commit changes the example to point to `main` branch, which does exist [2] [1] https://github.com/folke/lazy.nvim/branches/all?query=stable [2] https://github.com/folke/lazy.nvim/branches/all?query=main
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The installation documentation incorrectly points to the
stablebranch in the example. However, if you look at the lazy.nvim list of branches, you won't find astablebranch[1]. This commit changes the example to point tomainbranch, which does exist[2].[1] https://github.com/folke/lazy.nvim/branches/all?query=stable
[2] https://github.com/folke/lazy.nvim/branches/all?query=main
Without this, a user who incorrectly uses the
stablebranch instead ofmainwill get the errorfatal: couldn't find remote ref refs/heads/stablewill pop-up when executing:Lazy sync.Found the issue whilst doing a local
:Lazy synctroubleshooting. However, I ran into the issue described in #1971, which means updating my own locallazy.lua(from the example) did nothing. I ended up solving the problem by blowing away Lazy altogether via:rm -rf ~/.local/share/nvim/lazy/lazy.nvim.Related Issue(s)
This is directly related to #1971, which was incorrectly closed due to inactivity.