black/docs
Richard Si 8c3c190f99
Add Black compatible configurations in documentation (#1366 & #1205) (#1371)
* Add Black compatible configs in docs ( #1366 & #1205)

When users of Black are starting a new project or are adding Black to their
existing projects, they will usually have to config their existing tools like
flake8 to be compatible with Black. Usually, these configs are the same across
different projects. Yet, there isn't any consolidated infomation on what configs
are compatible. Leaving users of Black to dig out any infomation they can find
in README.md.

* Fix a bad max-line-length value

* Clean up pylint's configs

* Add explanations for each configurations

Copying and pasting code without understanding it is a bad idea. This goes the same
for users copying and pasting configurations.

* Capitalize Pylint

* Link from the README

* Fix the isort configuration

I referenced the wrong source. I used a pesonal configuration, not a pure Black-
compatible configuration.

* Improve the config explanations

The explanation for the isort configuration was pretty bad. After having fixed the
configuration (see commit 01c55d1), improving the its explanation was necessary to
make it more user-friendly and understandable. Also added fenced code blocks of the
raw configuration options so the explanations make sense.

* Improve README wording slightly

* Add @hugovk, @JelleZijlstra + my suggestions

Co-authored-by: Cooper Lees <cooper@fb.com>
2020-05-08 07:26:29 -07:00
..
_static Improve pypi badge template 2018-03-26 02:27:14 -07:00
reference Add docstrings to fmt checking functions, add to docs 2020-05-08 15:47:18 +02:00
authors.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
blackd.md blackd: a HTTP server for blackening (#460) 2018-09-17 10:02:25 -07:00
change_log.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
compatible_configs.md Add Black compatible configurations in documentation (#1366 & #1205) (#1371) 2020-05-08 07:26:29 -07:00
conf.py Omit commit hash and date stamp from doc version (#1322) 2020-03-28 19:06:00 -07:00
contributing_to_black.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
contributing.md Documentation fixes for ReadTheDocs 2018-03-24 17:15:48 -07:00
editor_integration.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
ignoring_unmodified_files.md Fix dangling file in documentation 2018-05-28 23:19:40 -07:00
index.rst Introduce a section of docs about exceptions 2020-03-04 22:26:45 +01:00
installation_and_usage.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
license.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
make.bat add sphinx docs skeleton (#71) 2018-03-23 14:27:04 -07:00
Makefile add sphinx docs skeleton (#71) 2018-03-23 14:27:04 -07:00
pyproject_toml.md Support pyproject.toml 2018-06-06 17:02:10 -07:00
requirements.txt Omit commit hash and date stamp from doc version (#1322) 2020-03-28 19:06:00 -07:00
show_your_style.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
testimonials.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
the_black_code_style.md Auto-generated documentation-related fixes 2018-03-28 17:43:18 -07:00
version_control_integration.md Link VCS integration in documentation 2018-04-05 13:45:16 -07:00