Skip to content

Add first line in doc for local-additions #3506

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jpc-hpe
Copy link

@jpc-hpe jpc-hpe commented Jul 19, 2025

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.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

After applying the change, a new entry appears under :help local-additions (or at the end of the main :helppage)

  • Test A: enter :help local-additions and verify that a new telescope.txt entry is present

Configuration:

  • Neovim version (nvim --version): NVIM v0.11.3a (with LazyVim)
  • Operating system and version: Debian 12.11 (running under WSL)

Checklist:

  • My code follows the style guidelines of this project (stylua)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (lua annotations)

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 any tags file, I assume that tags generation happens automatically with plugin installation

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
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.

1 participant