Skip to content

Commit 9329bfa

Browse files
committed
fixed jsdoc
1 parent ce60920 commit 9329bfa

File tree

5 files changed

+26
-22
lines changed

5 files changed

+26
-22
lines changed

docs/automations/integrations/jsdoc/review-jsdoc-input/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Automatically flag PRs that may require JSDoc updates.
44
category: [docs, javascript]
55
---
66
# Review JSDoc Input Parameters
7-
7+
<!-- --8<-- [start:example]-->
88
Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content.
99

1010

@@ -34,3 +34,4 @@ Warn PR authors when they change JavaScript function or constructor input parame
3434
</span>
3535
</div>
3636
</div>
37+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jsdoc/review-jsdoc-large/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Automatically flag large PRs that may require JSDoc updates.
44
category: [docs, javascript]
55
---
66
# Review JSDoc for Large Changes
7-
7+
<!-- --8<-- [start:example]-->
88
Require more extensive reviews for large JavaScript changes that lack JSDoc updates.
99

1010
<div class="automationImage" markdown="1">
@@ -35,3 +35,4 @@ Require more extensive reviews for large JavaScript changes that lack JSDoc upda
3535
</span>
3636
</div>
3737
</div>
38+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Enforce JSDoc requirements for PRs.
44
category: [docs, javascript]
55
---
66
# Enforce JSDoc for New JavaScript Classes
7-
7+
<!-- --8<-- [start:example]-->
88
Require JSDoc for all new JavaScript classes.
99

1010

@@ -36,3 +36,4 @@ Require JSDoc for all new JavaScript classes.
3636
</span>
3737
</div>
3838
</div>
39+
<!-- --8<-- [end:example]-->

docs/automations/integrations/jsdoc/review-jsdoc/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Automatically approve PRs for JSDoc changes.
44
category: [docs, javascript]
55
---
66
# Review JSDoc Changes
7-
7+
<!-- --8<-- [start:example]-->
88
Approve PRs that only contain changes to JSDoc and assign optional reviewers.
99

1010
<div class="automationImage" markdown="1">
@@ -35,3 +35,4 @@ Approve PRs that only contain changes to JSDoc and assign optional reviewers.
3535
</span>
3636
</div>
3737
</div>
38+
<!-- --8<-- [end:example]-->

docs/integrations/jsdoc.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ description: Implement workflow automations for JSDoc code reviews.
44
---
55
# Integrate gitStream with JSDoc
66

7-
JSDoc Examples:
7+
## Automation Examples
88

9-
* [Review JSDoc Changes](#review-jsdoc)
10-
* [Review JavaScript Input Parameters for JSDoc Changes](#review-jsdoc-input-parameters)
11-
* [Review JSDoc for Large Changes](#review-jsdoc-large-change)
12-
* [Enforce JSDoc Requirements for New Classes](#review-new-class-jsdoc)
9+
### Review JSDoc Changes
1310

11+
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc/README.md:example"
1412

15-
<a name="review-jsdoc"></a>
16-
## Review JSDoc Changes
17-
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc/README.md:6:"
13+
### Review JSDoc Input Parameters
1814

19-
<a name="review-jsdoc-input-parameters"></a>
20-
## Review JSDoc Input Parameters
21-
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-input/README.md:6:"
15+
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-input/README.md:example"
2216

23-
<a name="review-jsdoc-large-change"></a>
24-
## Review JSDoc for Large Changes
25-
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-large/README.md:6:"
17+
### Review JSDoc for Large Changes
2618

27-
<a name="review-new-class-jsdoc"></a>
28-
## Enforce JSDoc for New JavaScript Classes
29-
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md:6:"
19+
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-large/README.md:example"
3020

31-
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for help with these examples.
21+
### Enforce JSDoc for New JavaScript Classes
22+
23+
--8<-- "docs/automations/integrations/jsdoc/review-jsdoc-new-class/README.md:example"
24+
25+
## Additional Resources
26+
27+
--8<-- "docs/snippets/general.md"
28+
29+
--8<-- "docs/snippets/automation-footer.md"
30+
31+
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for help with these examples.

0 commit comments

Comments
 (0)