Skip to content

docs(plugin): add lazy.nvim install instruction #386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 7, 2023

Conversation

technicalpickles
Copy link
Contributor

An alternative to #367 , without listing out all the keys.

README.md Outdated
Comment on lines 23 to 29
{
'numToStr/Comment.nvim',
opts = {
-- add any options here
},
event = "BufRead",
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am looking at this, and it is not clear to me where to put this object. It would be great if you could more instruction to code snippet just like the vim-plug.

And I also don't want to recommend any lazy loading method to load the plugin, as I want to keep the instructions simple and clear. If people wants to lazy load, they can always refer to package manager docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a comment to the snippet.

Added lazy = false, but I'm kinda weary of it. I appreciate wanting to keep it simple, but I expect it would be a question lazy.nvim users have about how to best lazily load it, ie if there's an event or keys to add.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, you are saying lazy.nvim doesn't have any default mode? Like either you have to lazy load with event, keys etc. or explicitly specify lazy = false to not lazy load.

I don't use lazy.nvim so don't know much about it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, you are saying lazy.nvim doesn't have any default mode? Like either you have to lazy load with event, keys etc. or explicitly specify lazy = false to not lazy load.

I don't use lazy.nvim so don't know much about it.

lazy=false is a default value for lazy.nvim, setting it is redundant

@numToStr numToStr changed the title docs(plugin): Add basic lazy.nvim installation documentation docs(plugin): add lazy.nvim install instruction Aug 7, 2023
@numToStr numToStr merged commit 0236521 into numToStr:master Aug 7, 2023
@technicalpickles technicalpickles deleted the lazy-instructions branch August 7, 2023 17:38
@9mm
Copy link

9mm commented Aug 13, 2023

This is how I have lazy loaded it BTW. I recommend removing lazy = false from the docs as that makes it very confusing (as if the plugin will break otherwise).

Leaving off lazy = false will do that anyway.

Here is how I AM lazy loading it:

return {
  'numToStr/Comment.nvim',
  event = 'InsertEnter',
  config = function()
    require('Comment').setup({})
  end,
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants