docs: add hint on "@exclude-docs" annotation in context of class inhe…

…ritance
storybookjs · Jan 27, 2025 · 7787a88 · 7787a88
1 parent 508397a
commit 7787a88
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/packages/angular-demo/src/app/stories/component.mdx b/packages/angular-demo/src/app/stories/component.mdx
@@ -6,6 +6,25 @@ import { ChildComponent } from '../child.component';
 
 # Component
 
+> **Note**: If you have a class that is extending another class and you want to exclude certain property using
+> the `@exclude-docs` annotation, you need to add the annotation to all overrides of the property.
+
+```typescript
+export class ChildComponent extends BaseComponent {
+	/**
+	 * @exclude-docs
+	 */
+	override doNotShowMe = 42;
+}
+
+export class BaseComponent {
+	/**
+	 * @exclude-docs
+	 */
+	doNotShowMe = 41;
+}
+```
+
 ## AppComponent
 
 <ArgTypes of={AppComponent} />