hrsh7th/nvim-cmp

Documenting Defaults

Open

#943 opened on Apr 28, 2022

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Lua (9,420 stars) (437 forks)batch import
documentationhelp wanted

Description

Description

Would you consider adding the defaults of various settings to the documentation, for example somewhere under this option it would say that the default value is false.

Contributor guide

Tech stack
lua
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Look at the documentation file at doc/cmp.txt, specifically around line 426 where the option mentioned in the issue is described. Add a note indicating the default value (e.g., 'false' for that option). No code changes are needed.