]> git.madduck.net Git - etc/vim.git/blobdiff - 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
index 7a0995bb78136ebea5159c2bca6d91aed12448c5..4ca9877a3c445904256346ff910b642f8d18fe68 100644 (file)
@@ -4,7 +4,7 @@
 The uncompromising code formatter
 =================================
 
-By using *Black*, you agree to cease control over minutiae of
+By using *Black*, you agree to cede control over minutiae of
 hand-formatting. In return, *Black* gives you speed, determinism, and
 freedom from `pycodestyle` nagging about formatting. You will save time
 and mental energy for more important matters.
@@ -14,9 +14,11 @@ possible. Blackened code looks the same regardless of the project
 you're reading. Formatting becomes transparent after a while and you
 can focus on the content instead.
 
+Try it out now using the `Black Playground <https://black.now.sh>`_.
+
 .. note::
 
-   `Black is an early pre-release <usage.html#note-this-tool-is-alpha-quality-at-the-moment>`_.
+   `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
 
 
 Testimonials
@@ -26,7 +28,7 @@ Testimonials
 
    *Black is opinionated so you don't have to be.*
 
-**Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
+**Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core
 developer of Twisted and CPython:
 
    *An auto-formatter that doesn't suck is all I want for Xmas!*
@@ -46,11 +48,20 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   usage
-   technical_philosophy
+   installation_and_usage
+   the_black_code_style
+   pragmatism
+   pyproject_toml
+   editor_integration
+   blackd
+   black-primer
+   version_control_integration
+   ignoring_unmodified_files
    contributing
-   changelog
-
+   show_your_style
+   change_log
+   reference/reference_summary
+   authors
 
 Indices and tables
 ==================