Ruby: Use title case in section headers
- infos/provides = swig
- infos/description =
-# Ruby bindings
+# Ruby Bindings
This module is a SWIG generated Ruby binding for Elektra Core API - KDB
(https://www.libelektra.org) and its libtools library. So it consists of the two
@@ -17,7 +17,7 @@ The two modules provides wrapper classes the C++ interface and are
mainly a 1 to 1 mapping. However, to provide a more Ruby-style API,
the modules differs to the C++ API in the following way:
-## Ruby `Kdb` differences to C++ API
+## Ruby `Kdb` Differences to C++ API
- C++ iterators for `Key`/`KeySet` are excluded. Instead `KeySet` implements
an `each` method and includes `Enumerable`. Therefore it is very similar to
@@ -40,7 +40,7 @@ the modules differs to the C++ API in the following way:
- `Key` and `KeySet` methods directly modify the underlying `Key`/`KeySet`
- The `Key.setCallback` and `Key.getFunc` methods are not supported
-## Ruby `Kdbtools` differences to C++ API
+## Ruby `Kdbtools` Differences to C++ API
These bindings do not really change anything to the API and are basically a
direct 1:1 mapping. However the usual renaming from C++ camelcase to Rubys
@@ -54,7 +54,7 @@ Example and demo applications which a lot of documentation in it can be found
in the Ruby-bindings source tree under 'examples'. Also the test cases (under
'tests') can be a good point to look if you need more information.
-## Quick start guide
+## Quick Start Guide
This is a short example and illustrates how to use the binding:
@@ -77,7 +77,7 @@ Kdb.open do |db|
end
```
-## Get a KDB handle
+## Get a KDB Handle
There are two ways to create a KDB handle:
@@ -107,7 +107,7 @@ end
Note: after the block was executed, `db.close` is called implicitly, Thus you
can not use the handle afterwards.
-## Exception handling
+## Exception Handling
Exception handling is directly mapped from the C++ binding:
@@ -122,7 +122,7 @@ ensure
end
```
-## KeySet creation
+## KeySet Creation
A KeySet can be created in different ways:
@@ -154,7 +154,7 @@ Passing a KeySet of initial keys:
ks2 = Kdb::KeySet.new ks
```
-## Appending keys
+## Appending Keys
`KeySet` supports Ruby's "append" operator `<<`
@@ -162,7 +162,7 @@ ks2 = Kdb::KeySet.new ks
ks << Kdb::Key.new("user/sw/key1")
```
-## iteration
+## Iteration
`KeySet` has an `each` method and includes `Enumerable`
@@ -181,7 +181,7 @@ ks.delete "user/sw/key1"
ks.delete_at 2
```
-## Key creation
+## Key Creation
Keys can be created with a Hash-like variable argument list:
@@ -197,7 +197,7 @@ symbol value pairs. The symbol value pairs are interpreted as follows:
- any other symbol is interpreted as metadata key and therefore will add a new
metadata key.
-## Key metadata iteration
+## Key Metadata Iteration
This is very similar to the `KeySet` iteration and can be accessed with `meta`:
