summaryrefslogtreecommitdiffstats
path: root/python/yapf/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/yapf/README')
-rw-r--r--python/yapf/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/python/yapf/README b/python/yapf/README
new file mode 100644
index 0000000000..68b4dfce9a
--- /dev/null
+++ b/python/yapf/README
@@ -0,0 +1,8 @@
+In essence, the algorithm takes the code and reformats it to
+the best formatting that conforms to the style guide, even
+if the original code didn’t violate the style guide.
+
+The ultimate goal is that the code YAPF produces is as good
+as the code that a programmer would write if they were
+following the style guide. It takes away some of the drudgery
+of maintaining your code.