docs/api/yaml_check.md in platformos-check-0.4.12 vs docs/api/yaml_check.md in platformos-check-0.4.13
- old
+ new
@@ -1,13 +1,13 @@
-# JSON check API
+# YAML Check API
-For checking the content of `.yml` files.
+This API is designed for checking the content of `.yml` files.
```ruby
module PlatformosCheck
class MyCheckName < YamlCheck
category :yaml,
- # A check can belong to multiple categories. Valid ones:
+ # A check can belong to multiple categories. Valid categories are:
categories :translation, :performance
severity :suggestion # :error or :style
def on_file(file)
file # an instance of `PlatformosCheck::JsonFile`