Add more examples of autocmds and NoAutoFormatBuffer to help

Open
#52 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
vim
Domain
documentation

Research direction

Start by locating the existing documentation for autocmds and :NoAutoFormatBuffer, then compare its current guidance with the four scenarios listed in the issue. Add practical examples covering path exclusions, per-filetype default formatters, path-specific formatters, and manual buffer disabling; done means all four use cases are documented clearly.

Written by the indexing model from the issue text.

Description

enhancement

Would be nice to have some practical examples in the docs of how to:

  • Auto-format some filetype excluding certain paths.
  • Configure default formatter by filetype w/o enabling auto-format.
  • Auto-format w/ different formatters at different paths.
  • Auto-format but manually disable in some buffers with :NoAutoFormatBuffer.
Dominant language
Vim Script
Stars
1.1k
Forks
102
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from google/vim-codefmt

All issues in google/vim-codefmt

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.