Skip to content

Commit

Permalink
feat(lib): add link out to docs to all readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcook1186 committed Jun 20, 2024
1 parent 549230e commit d8a6181
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/builtins/coefficient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,5 @@ The required parameters are:
- `output-parameter`: this must be a string

You can fix this error by checking you are providing valid values for each parameter in the config.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/csv-lookup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,3 +176,5 @@ The required parameters are:
- `output`: this must be a string containing a name or a wildcard character (`"*"`)

You can fix this error by checking you are providing valid values for each parameter in the config.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
1 change: 1 addition & 0 deletions src/builtins/divide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,4 @@ Every element in the ``inputs` array must contain:
- whatever value you passed to `numerator`


For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/exponent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,5 @@ Every element in the ``inputs` array must contain:
### `InputValidationError`

This error arises when an invalid value is passed to `Exponent`. Typically, this can occur when a non-numeric value (such as a string made of alphabetic characters) is passed where a number or numeric string is expected. Please check that the types are correct for all the relevant fields in your `inputs` array.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/interpolation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,5 @@ There are also several validation errors that can arise, including:
- if the lengths of `x` and `y` are not equal
- if `x` or `y` are empty
- if the requested point to interpolate at is outside the range of `x`

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
1 change: 1 addition & 0 deletions src/builtins/multiply/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,4 @@ Every element in the ``inputs` array must contain:
- `duration`
- whatever values you passed to `input-parameters`

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/regex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,5 @@ You can fix this error by checking you are providing valid values for each param
### `RegexMismatchError`

This error arises when the requested regex cannot find any matches in the given data. If there are multiple matches, the plugin returns the first, but if there are none, it throws this error.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
3 changes: 3 additions & 0 deletions src/builtins/sci-embodied/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,6 @@ The results will be saved to a new `yaml` file in `./examples/outputs`.
This error class is used to describe a problem with one of the input values to `sci-embodied`. This is typically due to an incorrect type or a reference to a value that is not available.

You will receive a specific error message explaining which parameter is problematic, and you can check and replace where appropriate.


For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/sci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,5 @@ Every element in the `inputs` array must contain:
### Validation errors

There is also a validation step that checks that the `functional-unit` was provided in the plugin config. If you see an error reporting this value as missing, please check you have provided it.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,5 @@ The results will be saved to a new `yaml` file.
### `ProcessExecutionError`

This error is thrown when the program invoked in the spawned shell fails for some reason that is not known to IF. Since the shell executes arbitrary code, it is difficult for IF to provide specific errors - this is delegated to the developers of the executed program.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
2 changes: 2 additions & 0 deletions src/builtins/subtract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,5 @@ The results will be saved to a new `yaml` file in `manifests/outputs`.
### `InputValidationError`

This error arises when an invalid value is passed to `Subtract`. Typically, this can occur when a non-numeric value (such as a string made of alphabetic characters) is passed where a number or numeric string is expected. Please check that the types are correct for all the relevant fields in your `inputs` array.

For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors
3 changes: 3 additions & 0 deletions src/builtins/sum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,6 @@ Every element in the ``inputs` array must contain:
- `timestamp`
- `duration`
- whatever values you passed to `input-parameters`


For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors).

0 comments on commit d8a6181

Please sign in to comment.