Add first line in doc for local-additions #3506
Open
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 documentation for vim help pages states that a first line is required for the file to appear under
:help local-additions
, with the following format:*tag* description
This change adds such line
There was no issue created for this, but I can create one if required
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
After applying the change, a new entry appears under
:help local-additions
(or at the end of the main:help
page):help local-additions
and verify that a newtelescope.txt
entry is presentConfiguration:
Checklist:
Notes:
When modifiying directly on my running system, I had to run manually
helptags ++t $HOME/.local/share/nvim/lazy/telescope.nvim/doc
before a double click on the new entry was effective. But since the github repository does not contain anytags
file, I assume that tags generation happens automatically with plugin installation