]> git.madduck.net Git - etc/vim.git/blob - docs/index.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Add `black-primer` docs (#1427)
[etc/vim.git] / docs / index.rst
1 .. black documentation master file, created by
2    sphinx-quickstart on Fri Mar 23 10:53:30 2018.
3
4 The uncompromising code formatter
5 =================================
6
7 By using *Black*, you agree to cede control over minutiae of
8 hand-formatting. In return, *Black* gives you speed, determinism, and
9 freedom from `pycodestyle` nagging about formatting. You will save time
10 and mental energy for more important matters.
11
12 *Black* makes code review faster by producing the smallest diffs
13 possible. Blackened code looks the same regardless of the project
14 you're reading. Formatting becomes transparent after a while and you
15 can focus on the content instead.
16
17 Try it out now using the `Black Playground <https://black.now.sh>`_.
18
19 .. note::
20
21    `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
22
23
24 Testimonials
25 ------------
26
27 **Dusty Phillips**, `writer <https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips>`_:
28
29    *Black is opinionated so you don't have to be.*
30
31 **Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core
32 developer of Twisted and CPython:
33
34    *An auto-formatter that doesn't suck is all I want for Xmas!*
35
36 **Carl Meyer**, `Django <https://www.djangoproject.com/>`_ core developer:
37
38    *At least the name is good.*
39
40 **Kenneth Reitz**, creator of `requests <http://python-requests.org/>`_
41 and `pipenv <https://docs.pipenv.org/>`_:
42
43    *This vastly improves the formatting of our code. Thanks a ton!*
44
45 Contents
46 --------
47
48 .. toctree::
49    :maxdepth: 2
50
51    installation_and_usage
52    the_black_code_style
53    pragmatism
54    pyproject_toml
55    editor_integration
56    blackd
57    black-primer
58    version_control_integration
59    ignoring_unmodified_files
60    contributing
61    show_your_style
62    change_log
63    reference/reference_summary
64    authors
65
66 Indices and tables
67 ==================
68
69 * :ref:`genindex`
70 * :ref:`modindex`
71 * :ref:`search`