Skip to content

Commit 745e497

Browse files
committed
Update doc
1 parent 32122d8 commit 745e497

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/functions/customization.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,26 @@ You likely won't need to change this, but if you do, *you must include the envir
231231
}
232232
```
233233

234+
### Description
235+
236+
By default, Sidecar will generate a description for your Lambda function based on the deployment environment and the name of your app.
237+
238+
You likely won't need to customise it, however, you can if you want, although it has no direct impact.
239+
240+
```php
241+
class ExampleFunction extends LambdaFunction
242+
{
243+
public function description()
244+
{
245+
return sprintf('%s [%s]: Sidecar function `%s`.', ...[
246+
config('sidecar.app_name'),
247+
Sidecar::getEnvironment(),
248+
static::class,
249+
]);
250+
}
251+
}
252+
```
253+
234254
## Tags
235255

236256
A key-value array of strings of tags to be applied to your function, this can be used to organize your functions by owner, project or departement.

0 commit comments

Comments
 (0)