Ian Cordasco
8a2e7ff908
Trim trailing whitespace in compat docs
2016-07-20 08:17:33 -05:00
Ian Cordasco
370912988f
Document flake8-polyfill in compatibility section
...
Yesterday we released the flake8-polyfill package to help with Flake8
compatibility issues. This adds documentation to Flake8 to help people
use that and to guide them towards it.
2016-07-20 08:12:45 -05:00
Ian Cordasco
ec678de427
Document Legacy API
2016-07-14 08:13:10 -05:00
Ian Cordasco
469da96001
Add new Flake8 classifier to Trove list
2016-07-09 16:16:07 -05:00
Fabian Neundorf
fabb13c5d1
Use option name provided by the parser
...
When calling `add_option` it returns an `Option` object which can return the
primary name of the option via `get_opt_name`. This should be used primarily
in the cross compatible implementation so that the order of parameters does
not matter.
2016-07-09 21:27:19 +02:00
Ian Cordasco
5b8a875965
Add 3.0.0b2 release notes
2016-06-28 20:47:44 -05:00
Ian Cordasco
7fe5b359f7
Add high-level overview of how things fit together
...
There are now a lot of moving parts in Flake8. It can't help to give new
developers a high-level overview of how they all fit together to make
Flake8. =)
2016-06-26 20:28:24 -05:00
Ian Cordasco
b82e0d5176
Add forgotten release note
2016-06-26 06:44:05 -05:00
Ian Cordasco
5a9b7c27ab
Update compatibility docs
2016-06-26 06:41:47 -05:00
Ian Cordasco
00575214db
Add missing release notes
2016-06-25 12:29:58 -05:00
Ian Cordasco
cee691059f
Merge branch 'origin/proposed/3.0' into master
2016-06-25 12:01:02 -05:00
Ian Cordasco
6eb2e3a701
Add more release notes for 3.0.0b1
2016-06-25 11:55:52 -05:00
Ian Cordasco
7340b3e057
Add release note for 2.6.1
2016-06-25 11:40:41 -05:00
Ian Cordasco
5c8d767626
Rename dev subdirectory to plugin-development
...
This should make the contents clearer
2016-06-25 09:51:15 -05:00
Ian Cordasco
14ce512b9a
Add extra information to plugin dev index
2016-06-25 09:49:06 -05:00
Ian Cordasco
87b331c552
Add some notes for users about how to use plugins
2016-06-25 09:45:08 -05:00
Ian Cordasco
c2111656a6
Add descriptions of pycodestyle and mccable
2016-06-24 14:54:48 -05:00
Ian Cordasco
cae943bd44
Add missing - to sub-directories
2016-06-22 19:27:23 -05:00
Ian Cordasco
1de5da8a7f
Add more definitions to glossary
2016-06-22 19:27:10 -05:00
Ian Cordasco
478d5620d8
Correct example register_options method
2016-06-22 19:13:20 -05:00
Ian Cordasco
88d1dd280a
Start a glossary of terms
2016-06-22 14:34:14 -05:00
Ian Cordasco
601696d564
Trim whitespace from cross-compat plugin docs
2016-06-22 10:07:16 -05:00
Ian Cordasco
6c0d900a38
Write plugin cross-compatibility documentation
2016-06-22 08:40:53 -05:00
Ian Cordasco
9526e061a7
Add more detail about types of releases
2016-06-22 08:10:07 -05:00
Ian Cordasco
60b67f4ef3
Trim trailing whitespace
...
I need to get better at following my own contrib documentation
2016-06-22 08:05:47 -05:00
Ian Cordasco
f3cd7ee6fb
Update FAQ to be a bit clearer
2016-06-21 07:36:40 -05:00
Ian Cordasco
a4c1edb03e
Add FAQ
2016-06-20 20:54:31 -05:00
Ian Cordasco
b67d1d633e
Add documentation about release versioning and process
2016-06-20 20:53:47 -05:00
Ian Cordasco
590e15cb4c
Trim trailing whitespace in docs
2016-06-20 13:42:48 -05:00
Ian Cordasco
3e8bbc50dc
Add documentation ... for writing documentation
2016-06-20 09:26:01 -05:00
Ian Cordasco
41277ff965
Use |Flake8| consistently throughout documentation
2016-06-20 08:13:50 -05:00
Ian Cordasco
57ac6ab699
Add |Flake8| substitution to the epilog
...
The rst_epilog config value in Sphinx allows you to maintain a global
list of replaces or includes that are appended to the text of each
document in your documentation. This allows us to use |Flake8| everywhere
without redefining the replace in every document.
2016-06-20 08:04:33 -05:00
Ian Cordasco
16f58005bf
Add --benchmark option documentation
2016-06-19 20:41:19 -05:00
Cea Stapleton
330fdb5b56
Grammar and clarity improvements.
2016-06-19 14:06:26 -05:00
Ian Cordasco
1de71fbe89
Set a default value for --select
...
This allows us to add --append-to-select and --append-to-ignore at a
later date that will work as expected and in a consistent manner.
2016-06-16 08:27:28 -05:00
Ian Cordasco
b1f039a476
Add information about new --verbose behaviour
2016-06-15 09:20:26 -05:00
Ian Cordasco
25502f6ade
Add note about # noqa: <errors>
2016-06-15 07:48:46 -05:00
Ian Cordasco
29419b0ac3
Start a changelog entry for 3.0.0
2016-06-14 20:48:04 -05:00
Ian Cordasco
e2ef07fe80
Copied one too many lines from template
2016-06-14 20:47:35 -05:00
Ian Cordasco
8bb3048775
Add documentation for --install-hook
2016-06-14 20:43:00 -05:00
Ian Cordasco
8a18cfa4a3
Add documentation around specifying a format string
2016-06-14 20:10:09 -05:00
Ian Cordasco
18d6e6264c
Revert silliness around setting choices for --format
...
If we restrict the user's ability to specify a format string, we break
existing workflows.
2016-06-14 20:04:52 -05:00
Ian Cordasco
472e7c9589
Add release notes portion of documentation
2016-06-14 09:58:24 -05:00
Ian Cordasco
706520828d
Fix documentation build
2016-06-14 09:57:49 -05:00
Ian Cordasco
107f595d13
Add flake8.api and docs for it
...
Stub out the primary method people seem to use.
2016-06-08 11:48:36 -05:00
Ian Cordasco
55f10211a3
Check for version of Python on Windows
...
Certain versions of Python on Windows are capable of using
multiprocessing safely and correctly. Instead of completely disabling
multiprocessing on Windows, this allows us to check for safe versions.
This also updates our internal utility documentation to add missing
functions and add a strongly worded warning about the API of those
functions.
2016-06-07 19:56:41 -05:00
Ian Cordasco
27dbd61f12
Add documentation around ignoring errors
2016-06-07 18:46:24 -05:00
Ian Cordasco
02bcbee245
Add --stdin-display-name to modify report output
2016-06-06 19:46:29 -05:00
Ian Cordasco
e93091575c
Remove last trailing whitespace
2016-06-04 15:23:31 -05:00
Ian Cordasco
0fbfeb919a
Trim trailing whitespace in contributing docs
2016-06-04 15:19:11 -05:00
