Skip to content

Commit

Permalink
remove readonly from markdown report for future bug fix
Browse files Browse the repository at this point in the history
  • Loading branch information
marshallstock committed Jun 7, 2022
1 parent 48e4046 commit a41f3fa
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 32 deletions.
9 changes: 1 addition & 8 deletions apps/api-documenter/src/documenters/MarkdownDocumenter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ import {
IResolveDeclarationReferenceResult,
ApiTypeAlias,
ExcerptToken,
ApiOptionalMixin,
ApiReadonlyMixin
ApiOptionalMixin
} from '@microsoft/api-extractor-model';

import { CustomDocNodes } from '../nodes/CustomDocNodeKind';
Expand Down Expand Up @@ -1019,12 +1018,6 @@ export class MarkdownDocumenter {
}
}

if (ApiReadonlyMixin.isBaseClassOf(apiItem)) {
if (apiItem.isReadonly) {
section.appendNodeInParagraph(new DocCodeSpan({ configuration, code: 'readonly' }));
}
}

return new DocTableCell({ configuration }, section.nodes);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ The constructor for this class is marked as internal. Third-party code should no
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [malformedEvent](./api-documenter-test.docclass1.malformedevent.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This event should have been marked as readonly. |
| [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. |
| [modifiedEvent](./api-documenter-test.docclass1.modifiedevent.md) | | [SystemEvent](./api-documenter-test.systemevent.md) | This event is fired whenever the object is modified. |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | <code>readonly</code> | string | |
| [readonlyProperty](./api-documenter-test.docclass1.readonlyproperty.md) | | string | |
| [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. |
| [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md) | <code>static</code><code>readonly</code> | boolean | |
| [staticReadonlyThing](./api-documenter-test.docclass1.staticreadonlything.md) | <code>static</code> | boolean | |
| [writeableProperty](./api-documenter-test.docclass1.writeableproperty.md) | | string | |
| [writeonlyProperty](./api-documenter-test.docclass1.writeonlyproperty.md) | | string | API Extractor will surface an <code>ae-missing-getter</code> finding for this property. |
Expand Down
22 changes: 11 additions & 11 deletions build-tests/install-test-workspace/workspace/common/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

0 comments on commit a41f3fa

Please sign in to comment.