Updated readme to show that setup is required for plugin to work correctly. #5
Conversation
This file contains 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
Normanras
suggested changes
Oct 20, 2023
There was a problem hiding this comment.
On line 36, you mention pulse.setup() but your config examples above doesn't set pulse as a local variable. I would keep it consistent since anything below that sets a local pulse variable.
This might be just me, but so many of my other plugin configs get entered into a table in those same setup parentheses. I'd consider adding to line 51 something that says you can add pulse.add() below/outside the closed setup parenthesis.
|
@Normanras could you take another look and see if this is clearer? |
Normanras
approved these changes
Oct 20, 2023
Normanras
approved these changes
Oct 20, 2023
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.
I should have included that the
setup()call topulse.nvimwas required to get access to editor commands. This documentation patch clarifies that and shows the base install configuration.This closes #4.