Skip to content

Commit 5e3e482

Browse files
ChriscbrChriscbr
authored
chore: update docs (#317)
1 parent d172580 commit 5e3e482

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+1386
-944
lines changed

‎bedrock/API.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,48 @@
1-
<h2>API Reference</h2>
1+
## API Reference
22

3-
<h3>Table of Contents</h3>
3+
### Table of Contents
44

55
- **Classes**
66
- <a href="#@winglibs/bedrock.JokeMaker">JokeMaker</a>
77
- <a href="#@winglibs/bedrock.Model">Model</a>
88

9-
<h3 id="@winglibs/bedrock.JokeMaker">JokeMaker (preflight class)</h3>
9+
### JokeMaker (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.JokeMaker"></a>
1010

11-
<h4>Constructor</h4>
11+
*No description*
1212

13-
<pre>
13+
#### Constructor
14+
15+
```
1416
new(): JokeMaker
15-
</pre>
17+
```
1618

17-
<h4>Properties</h4>
19+
#### Properties
1820

1921
*No properties*
2022

21-
<h4>Methods</h4>
23+
#### Methods
2224

2325
| **Signature** | **Description** |
2426
| --- | --- |
2527
| <code>inflight makeJoke(topic: str): str</code> | *No description* |
2628

27-
<h3 id="@winglibs/bedrock.Model">Model (preflight class)</h3>
29+
### Model (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.Model"></a>
30+
31+
*No description*
2832

29-
<h4>Constructor</h4>
33+
#### Constructor
3034

31-
<pre>
35+
```
3236
new(modelId: str): Model
33-
</pre>
37+
```
3438

35-
<h4>Properties</h4>
39+
#### Properties
3640

3741
| **Name** | **Type** | **Description** |
3842
| --- | --- | --- |
3943
| <code>modelId</code> | <code>str</code> | *No description* |
4044

41-
<h4>Methods</h4>
45+
#### Methods
4246

4347
| **Signature** | **Description** |
4448
| --- | --- |

‎bedrock/package-lock.json

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

‎bedrock/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@winglibs/bedrock",
33
"description": "A Wing library for Amazon Bedrock",
4-
"version": "0.1.1",
4+
"version": "0.1.2",
55
"author": {
66
"name": "Eyal Keren",
77
"email": "[email protected]"

‎budget/API.md

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<h2>API Reference</h2>
1+
## API Reference
22

3-
<h3>Table of Contents</h3>
3+
### Table of Contents
44

55
- **Classes**
66
- <a href="#@winglibs/budget.Alert">Alert</a>
@@ -14,85 +14,97 @@
1414
- **Enums**
1515
- <a href="#@winglibs/budget.TimeUnit">TimeUnit</a>
1616

17-
<h3 id="@winglibs/budget.Alert">Alert (preflight class)</h3>
17+
### Alert (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Alert"></a>
1818

19-
<h4>Constructor</h4>
19+
*No description*
2020

21-
<pre>
21+
#### Constructor
22+
23+
```
2224
new(props: AlertProps): Alert
23-
</pre>
25+
```
2426

25-
<h4>Properties</h4>
27+
#### Properties
2628

2729
*No properties*
2830

29-
<h4>Methods</h4>
31+
#### Methods
3032

3133
*No methods*
3234

33-
<h3 id="@winglibs/budget.AlertTfAws">AlertTfAws (preflight class)</h3>
35+
### AlertTfAws (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertTfAws"></a>
36+
37+
*No description*
3438

35-
<h4>Constructor</h4>
39+
#### Constructor
3640

37-
<pre>
41+
```
3842
new(props: AlertProps): AlertTfAws
39-
</pre>
43+
```
4044

41-
<h4>Properties</h4>
45+
#### Properties
4246

4347
*No properties*
4448

45-
<h4>Methods</h4>
49+
#### Methods
4650

4751
*No methods*
4852

49-
<h3 id="@winglibs/budget.AlertSim">AlertSim (preflight class)</h3>
53+
### AlertSim (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertSim"></a>
5054

51-
<h4>Constructor</h4>
55+
*No description*
5256

53-
<pre>
57+
#### Constructor
58+
59+
```
5460
new(props: AlertProps): AlertSim
55-
</pre>
61+
```
5662

57-
<h4>Properties</h4>
63+
#### Properties
5864

5965
*No properties*
6066

61-
<h4>Methods</h4>
67+
#### Methods
6268

6369
*No methods*
6470

65-
<h3 id="@winglibs/budget.Util">Util (preflight class)</h3>
71+
### Util (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Util"></a>
72+
73+
*No description*
6674

67-
<h4>Constructor</h4>
75+
#### Constructor
6876

69-
<pre>
77+
```
7078
new(): Util
71-
</pre>
79+
```
7280

73-
<h4>Properties</h4>
81+
#### Properties
7482

7583
*No properties*
7684

77-
<h4>Methods</h4>
85+
#### Methods
7886

7987
| **Signature** | **Description** |
8088
| --- | --- |
8189
| <code>static timeUnitToStr(timeUnit: TimeUnit): str</code> | *No description* |
8290

83-
<h3 id="@winglibs/budget.IAlert">IAlert (interface)</h3>
91+
### IAlert (interface) <a class="wing-docs-anchor" id="@winglibs/budget.IAlert"></a>
8492

85-
<h4>Properties</h4>
93+
*No description*
94+
95+
#### Properties
8696

8797
*No properties*
8898

89-
<h4>Methods</h4>
99+
#### Methods
90100

91101
*No methods*
92102

93-
<h3 id="@winglibs/budget.AlertProps">AlertProps (struct)</h3>
103+
### AlertProps (struct) <a class="wing-docs-anchor" id="@winglibs/budget.AlertProps"></a>
104+
105+
*No description*
94106

95-
<h4>Properties</h4>
107+
#### Properties
96108

97109
| **Name** | **Type** | **Description** |
98110
| --- | --- | --- |
@@ -101,9 +113,11 @@ new(): Util
101113
| <code>name</code> | <code>str</code> | *No description* |
102114
| <code>timeUnit</code> | <code>TimeUnit?</code> | *No description* |
103115

104-
<h3 id="@winglibs/budget.TimeUnit">TimeUnit (enum)</h3>
116+
### TimeUnit (enum) <a class="wing-docs-anchor" id="@winglibs/budget.TimeUnit"></a>
117+
118+
*No description*
105119

106-
<h4>Values</h4>
120+
#### Values
107121

108122
| **Name** | **Description** |
109123
| --- | --- |

‎budget/package-lock.json

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

‎budget/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@winglibs/budget",
3-
"version": "0.1.6",
3+
"version": "0.1.7",
44
"description": "AWS Budget",
55
"keywords": [
66
"AWS",

0 commit comments

Comments
 (0)