masukomi / masukomi/vim-markdown-folding
Mention in the readme that overriding user's foldtext is a configurable option
Nobody has claimed this yet.
- Dominant language
- Vim Script
- Stars
- 257
- Forks
- 44
- PR merge metrics
- No merged PRs in 30d
Description
I was frustrated to see that this plugin set the foldtext on behalf of the user (not expected since the readme says this plugin only consists of fold expressions) but after a quick look at the source was pleased to see that an option exists to disable this functionality - it would probably save some confusion for others if this behaviour, and the option itself was mentioned in the readme.
the option is:
`let g:markdown_fold_override_foldtext=0`
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the README and find the section describing the plugin's fold expressions or configuration. Document that it may override foldtext and include the g:markdown_fold_override_foldtext=0 option for disabling that behavior. Done means users can discover both the default behavior and the configuration switch.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 70/100