Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Vim plugin docs improvements #3468

Merged
merged 9 commits into from
Dec 20, 2022
Merged

Vim plugin docs improvements #3468

merged 9 commits into from
Dec 20, 2022

Commits on Dec 20, 2022

  1. Organize vim plugin section with headers to separate out Installation… 

    …, Usage, and Troubleshooting for readability and easy linking
    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    26c56f2 View commit details
    Browse the repository at this point in the history

  2. Add missing plugin configuration options, with current defaults

    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    9929893 View commit details
    Browse the repository at this point in the history

  3. Add installation note for Arch Linux, now that the plugin is shipped … 

    …with the python-black package (ref: https://bugs.archlinux.org/task/73024)
    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    bb0f446 View commit details
    Browse the repository at this point in the history

  4. Fix vim-plug specification to follow stable releases. Moving the same… 

    … tag is an antipattern that doesn't re-resolve with vim-plug, see this discussion for more detail (https://github.com/junegunn/vim-plug/pull/720\#issuecomment-1105829356). Per vim-plug's maintainer's recommendation, use the 'tag' key instead with a shell wildcard. Wildcard should be '*.*.*' as that follows Black's versioning detailed here (https://black.readthedocs.io/en/latest/contributing/release_process.html\#cutting-a-release) and doesn't include current alpha releases.
    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    1a73b72 View commit details
    Browse the repository at this point in the history

  5. put the ale plugin back, i moved it misinterpreting where it should go

    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    197edbd View commit details
    Browse the repository at this point in the history

  6. praise to the linter

    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    72667be View commit details
    Browse the repository at this point in the history

  7. maintainer feedback, expand the vim-plug section a bit and add a chan… 

    …gelog entry
    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    ebe7219 View commit details
    Browse the repository at this point in the history

  8. fix broken docs link

    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    1c45927 View commit details
    Browse the repository at this point in the history

  9. feedback, move installation note to the installation section (crazy r… 

    …ight) and tweak some punctuation
    @matthewarmand
    matthewarmand committed Dec 20, 2022
    Configuration menu
    Copy the full SHA
    58c1080 View commit details
    Browse the repository at this point in the history