README.md in inch-0.3.0 vs README.md in inch-0.3.1.rc1
- old
+ new
@@ -1,16 +1,16 @@
-# Inch [](https://travis-ci.org/rrrene/inch)
+# Inch [](https://travis-ci.org/rrrene/inch) [](https://codeclimate.com/github/rrrene/inch) [](http://inch-pages.github.io/github/rrrene/inch)
`inch` gives you hints where to improve your docs. One Inch at a time.
Take a look at the [project page with screenshots (live and in full color)](http://rrrene.github.io/inch/).
## What can it do?
`inch` is a little bit like Code Climate, but for your inline code documentation (and not a webservice).
-It is a command-line utility that suggests places in your codebase where documentation can be improved.
+It is a command-line utility that suggests places in your codebase where documentation can be improved.
If there are no inline-docs yet, `inch` can tell you where to start.
@@ -59,24 +59,24 @@
```
Inch will suggest that the docs could be improved:
# Properly documented, could be improved:
-
+
┃ B ↑ Foo#complicated
-
+
# Undocumented:
-
+
┃ U ↑ Foo
┃ U ↗ Foo#filename
-
+
You might want to look at these files:
-
+
┃ lib/foo.rb
-
+
Grade distribution (undocumented, C, B, A): █ ▁ ▄ ▄
-
+
Only considering priority objects: ↑ ↗ → (use `--help` for options).
## Philosophy
@@ -142,12 +142,12 @@
* There is a significant amount of documentation present.
* The present documentation seems good.
* There are still undocumented methods.
Inch does not really tell you what to do from here. It suggests objects and
-files that could be improved to get a better rating, but that is all. This
+files that could be improved to get a better rating, but that is all. This
way, it is perfectly reasonable to leave parts of your codebase
-undocumented.
+undocumented.
Instead of reporting
coverage: 67.1% 46 ouf of 140 checks failed