Skip to content

Commit c94fda7

Browse files
committed
Remove reference to WIP feature from README
1 parent ac64805 commit c94fda7

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

.config/typedoc.preamble.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ Annotation tags consist of the following parts:
7878
- If omitted, the annotation targets only 1 line or target search query match. Depending on the location of the annotation, this may be above, below, or on the line containing the annotation itself.
7979
- The following range types are supported:
8080
- A **numeric range** defined by positive or negative numbers, e.g. `:3`, `:-1`. Positive ranges extend downwards, negative ranges extend upwards from the location of the annotation. If the annotation shares a line with code, the range starts at this line. Otherwise, it starts at the first non-annotation line in the direction of the range. The special range `:0` can be used to create standalone annotations that do not target any code.
81-
- A **range between two matching annotations** defined by the suffixes `:start` and `:end`, e.g. `// [!ins:start]`, followed by some code lines, and a matching `// [!ins:end]` to mark the end of the inserted code.
8281
- The **closing sequence** `]`
8382

8483
### Annotation content
@@ -223,7 +222,7 @@ Note: Accurately detecting single-line and multi-line comments in all supported
223222
[!ins]
224223
[!note] This is a note annotation.
225224
*/
226-
225+
227226
✅ Recognized:
228227
/**
229228
* JSDoc-style comments are also supported.

packages/annotation-comments/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ Annotation tags consist of the following parts:
7878
- If omitted, the annotation targets only 1 line or target search query match. Depending on the location of the annotation, this may be above, below, or on the line containing the annotation itself.
7979
- The following range types are supported:
8080
- A **numeric range** defined by positive or negative numbers, e.g. `:3`, `:-1`. Positive ranges extend downwards, negative ranges extend upwards from the location of the annotation. If the annotation shares a line with code, the range starts at this line. Otherwise, it starts at the first non-annotation line in the direction of the range. The special range `:0` can be used to create standalone annotations that do not target any code.
81-
- A **range between two matching annotations** defined by the suffixes `:start` and `:end`, e.g. `// [!ins:start]`, followed by some code lines, and a matching `// [!ins:end]` to mark the end of the inserted code.
8281
- The **closing sequence** `]`
8382

8483
### Annotation content
@@ -675,7 +674,7 @@ The handler can return `true` to indicate that it has taken care of the change a
675674
##### removeAnnotationContents?
676675

677676
```ts
678-
optional removeAnnotationContents:
677+
optional removeAnnotationContents:
679678
| boolean
680679
| (context: CleanAnnotationContext) => boolean;
681680
```

0 commit comments

Comments
 (0)