Skip to content

Commit 7a1673f

Browse files
author
Kevin Paulisse
committed
Bigger headings, misc. wording
1 parent a4c95ca commit 7a1673f

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

doc/dev/api/v1/config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,26 @@ options = OctocatalogDiff::API::V1.config(
1212
)
1313
```
1414

15-
#### Options
15+
## Options
1616

1717
- **`:filename`** (String, optional): Full path to configuration file to read. If not provided, the configuration file will be searched as described in [Configuration](/doc/configuration.md).
1818

1919
- **`:logger`** (Logger, optional): Logger object. If provided, debug messages and fatal errors will be logged to this object.
2020

2121
- **`:test`** (Boolean, optional): Test mode, defaults to false. If true, the value of the configuration settings will be logged to the logger (with priority DEBUG) and an exception will be raised if the configuration file cannot be located.
2222

23-
#### Return value
23+
## Return value
2424

2525
If the configuration file is located and valid, the return value is a Hash consisting of the options defined in the configuration file.
2626

27-
If the configuration file cannot be found, the return value is an empty Hash (`{}`). Except, if you specified `:test => true`, an exception will be raised.
27+
If the configuration file cannot be found, the return value is an empty Hash (`{}`). Except, with `:test => true`, an exception will be raised.
2828

29-
#### Exceptions
29+
## Exceptions
3030

3131
- `OctocatalogDiff::Errors::ConfigurationFileContentError`
3232

33-
Raised if the configuration file could not be parsed. A more specific error message will help identify the cause. Possible causes include the file not being valid ruby, the file not containing the expected structure or methods, or the method returning something other than a Hash.
33+
Raised if the configuration file could not be evaluated. A more specific error message will help identify the cause. Possible causes include the file not being valid ruby, the file not containing the expected structure or methods, or the method returning something other than a Hash.
3434

3535
- `OctocatalogDiff::Errors::ConfigurationFileNotFoundError`
3636

37-
Raised if the configuration file could not be found, *and* `:test => true` was supplied.
37+
Raised if the configuration file could not be found, *and* `:test => true` was supplied. (Note, if no configuration file is found, but `:test => false`, no error is raised, and `{}` is returned.)

0 commit comments

Comments
 (0)