Fix missing documentation requirments

vimeo · May 5, 2023 · 3c84367 · 3c84367
1 parent 654202f
commit 3c84367
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 9 deletions.
diff --git a/config.xsd b/config.xsd
@@ -250,6 +250,7 @@
             <xs:element name="InaccessibleClassConstant" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="InaccessibleMethod" type="MethodIssueHandlerType" minOccurs="0" />
             <xs:element name="InaccessibleProperty" type="IssueHandlerType" minOccurs="0" />
+            <xs:element name="InheritorViolation" type="ClassIssueHandlerType" minOccurs="0" />
             <xs:element name="InterfaceInstantiation" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="InternalClass" type="ClassIssueHandlerType" minOccurs="0" />
             <xs:element name="InternalMethod" type="MethodIssueHandlerType" minOccurs="0" />

diff --git a/docs/annotating_code/supported_annotations.md b/docs/annotating_code/supported_annotations.md
@@ -743,19 +743,13 @@ Used to tell Psalm that a class can only be extended by a certain subset of clas
 
 For example, 
 ```php
+<?php
 /**
  * @psalm-inheritors FooClass|BarClass
  */
 class BaseClass {}
-
-class FooClass extends BaseClass {
-  public function thing(string $s) : void { return $s . "hello"; }
-}
-
-class BarClass extends BaseClass {
-  public function thing(int $i) : string { return $i . "hello"; }
-}
-
+class FooClass extends BaseClass {}
+class BarClass extends BaseClass {}
 class BazClass extends BaseClass {} // this is an error
 ```
 

diff --git a/docs/running_psalm/issues.md b/docs/running_psalm/issues.md
@@ -52,6 +52,7 @@
  - [InaccessibleClassConstant](issues/InaccessibleClassConstant.md)
  - [InaccessibleMethod](issues/InaccessibleMethod.md)
  - [InaccessibleProperty](issues/InaccessibleProperty.md)
+ - [InheritorViolation](issues/InheritorViolation.md)
  - [InterfaceInstantiation](issues/InterfaceInstantiation.md)
  - [InternalClass](issues/InternalClass.md)
  - [InternalMethod](issues/InternalMethod.md)