Skip to content

Commit a41f3fa

Browse files
committed
remove readonly from markdown report for future bug fix
1 parent 48e4046 commit a41f3fa

File tree

4 files changed

+15
-32
lines changed

4 files changed

+15
-32
lines changed

apps/api-documenter/src/documenters/MarkdownDocumenter.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ import {
4040
IResolveDeclarationReferenceResult,
4141
ApiTypeAlias,
4242
ExcerptToken,
43-
ApiOptionalMixin,
44-
ApiReadonlyMixin
43+
ApiOptionalMixin
4544
} from '@microsoft/api-extractor-model';
4645

4746
import { CustomDocNodes } from '../nodes/CustomDocNodeKind';
@@ -1019,12 +1018,6 @@ export class MarkdownDocumenter {
10191018
}
10201019
}
10211020

1022-
if (ApiReadonlyMixin.isBaseClassOf(apiItem)) {
1023-
if (apiItem.isReadonly) {
1024-
section.appendNodeInParagraph(new DocCodeSpan({ configuration, code: 'readonly' }));
1025-
}
1026-
}
1027-
10281021
return new DocTableCell({ configuration }, section.nodes);
10291022
}
10301023

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ The constructor for this class is marked as internal. Third-party code should no
2929
| Property | Modifiers | Type | Description |
3030
| --- | --- | --- | --- |
3131
| [malformedEvent](./api-documenter-test.docclass1.malformedevent.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This event should have been marked as readonly. |
32-
| [modifiedEvent](./api-documenter-test.docclass1.modifiedevent.md) | <code>readonly</code> | [SystemEvent](./api-documenter-test.systemevent.md) | This event is fired whenever the object is modified. |
32+
| [modifiedEvent](./api-documenter-test.docclass1.modifiedevent.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This event is fired whenever the object is modified. |
3333
3434
## Properties
3535
3636
| Property | Modifiers | Type | Description |
3737
| --- | --- | --- | --- |
38-
| [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | <code>readonly</code> | string | |
38+
| [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | | string | |
3939
| [regularProperty](./api-documenter-test.docclass1.regularproperty.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This is a regular property that happens to use the SystemEvent type. |
40-
| [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md) | <code>static</code><code>readonly</code> | boolean | |
40+
| [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md) | <code>static</code> | boolean | |
4141
| [writeableProperty](./api-documenter-test.docclass1.writeableproperty.md) | | string | |
4242
| [writeonlyProperty](./api-documenter-test.docclass1.writeonlyproperty.md) | | string | API Extractor will surface an <code>ae-missing-getter</code> finding for this property. |
4343

build-tests/install-test-workspace/workspace/common/pnpm-lock.yaml

Lines changed: 11 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

common/changes/@microsoft/api-documenter/api-readonly-mixin_2022-05-19-20-18.json

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)