From 896790d30c19c131c1024231e7da07afc22131be Mon Sep 17 00:00:00 2001 From: Matthew Brown Date: Wed, 20 Jun 2018 00:33:32 -0400 Subject: [PATCH] Add documentation for recently-added features --- docs/configuration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index d4ff3e757..3ef8ee052 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -37,6 +37,12 @@ Psalm uses an XML config file. A barebones example looks like this: When `true`, strings can be coerced to [`class-string`](supported_annotations.md#class-constants), with Psalm emitting a `TypeCoercion` issue. If disabled, that issue changes to a more serious one. Defaults to `true`. - `allowStringToStandInForClass=[bool]`
When `true`, strings can be used as classes, meaning `$some_string::someMethod()` is allowed. If `false`, only class constant strings (of the form `Foo\Bar::class`) can stand in for classes, otherwise an `InvalidStringClass` issue is emitted. Defaults to `true` (no issues emitted). +- `memoizeMethodCallResults=[bool]`
+ When `true`, the results of method calls without arguments passed arguments are remembered between repeated calls of that method on a given object. Defaults to `false`. +- `hoistConstants=[bool]`
+ When `true`, constants defined in a function in a file are assumed to be available when requiring that file, and not just when calling that function. Defaults to `false` (i.e. constants defined in functions will *only* be available for use when that function is called) +- `addParamDefaultToDocblockType=[bool]`
+ Occasionally a param default will not match up with the docblock type. By default, Psalm emits an issue. Setting this flag to `true` causes it to expand the param type to include the param default. Defaults to `false`. ### Running Psalm