chore(sdk): OLD adding eslint rules for capitalize comment and explicit member accessibility

docs/contributing/01-start-here/06-pull-requests.md

@@ -12,18 +12,18 @@ create your own fork of the Wing repository and make a pull request.
 
 To help maintainers review them and get them merged in a speedy fashion, please check:
 
-* [ ] Your pull request has a [descriptive title](#how-are-pull-request-titles-formatted).
-* [ ] A description of your changes are included, and a reference to a corresponding issue. (This is also a great place to shout-out anyone who helped with the changes!)
-* [ ] Tests are added for all changes.
-* [ ] Any handwritten documentation in `docs/` or READMEs are updated where appropriate when features are being added or removed (API docs will be automatically generated for you!).
-* [ ] Your fork is in sync with the upstream repository.
-* [ ] All build checks on GitHub are passing.
+- [ ] Your pull request has a [descriptive title](#how-are-pull-request-titles-formatted).
+- [ ] A description of your changes are included, and a reference to a corresponding issue. (This is also a great place to shout-out anyone who helped with the changes!)
+- [ ] Tests are added for all changes.
+- [ ] Any handwritten documentation in `docs/` or READMEs are updated where appropriate when features are being added or removed (API docs will be automatically generated for you!).
+      Please make sure to start docstrings with a capital letter.
+- [ ] Your fork is in sync with the upstream repository.
+- [ ] All build checks on GitHub are passing.
 
 We also recommend you avoid force pushing or rebasing your branch after a pull request has been
 opened in order to make it easier to review. Your commit history doesn't need to be perfect, since
 it will get squashed into a single commit when the pull request is merged anyway.
 
-
 ### How are pull request titles formatted?
 
 We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to generate our
@@ -33,38 +33,38 @@ changelog. To that end, pull request titles must follow this convention:
 <type>(<scope>): <subject>
 ```
 
-* `<type>` must be be one of:
-  * `feat` (new feature)
-  * `fix` (bug fix)
-  * `docs` (documentation update)
-  * `rfc` (new/update to an RFC doc)
-  * `chore` (not included in changelog)
-  * `revert` (undoing a past change)
-* `<scope>` must be one of:
-  * `compiler`
-  * `sdk`
-  * `docs`
-  * `cli`
-  * `examples`
-  * `playground`
-  * `tutorial`
-  * `vscode`
-  * `plugins`
-  * `build` - change related to development environment, build system, build tools, etc.
-  * `repo` - change related to repository behavior (e.g. pull request templates, issue templates,
+- `<type>` must be be one of:
+  - `feat` (new feature)
+  - `fix` (bug fix)
+  - `docs` (documentation update)
+  - `rfc` (new/update to an RFC doc)
+  - `chore` (not included in changelog)
+  - `revert` (undoing a past change)
+- `<scope>` must be one of:
+  - `compiler`
+  - `sdk`
+  - `docs`
+  - `cli`
+  - `examples`
+  - `playground`
+  - `tutorial`
+  - `vscode`
+  - `plugins`
+  - `build` - change related to development environment, build system, build tools, etc.
+  - `repo` - change related to repository behavior (e.g. pull request templates, issue templates,
     etc).
-* `<subject>`
-  * Prefer lowercase (except for proper nouns) and do not include a period (improves aesthetics of changelog).
-  * For `fix` changes, subject should describe the problem, not the solution (e.g. `fix(cli): intermediate.js file not found` instead of ~`fix(cli): make sure output directory exists`~).
-  * For `feat` changes, subject should describe the feature, not the activity of adding the feature (e.g. `feat(sdk): google cloud platform support` instead of `feat(sdk): add tf-gcp target to sdk`).
-  * For `rfc` changes, subject should be the title of the rfc (e.g. `rfc(cli): run command` instead
+- `<subject>`
+  - Prefer lowercase (except for proper nouns) and do not include a period (improves aesthetics of changelog).
+  - For `fix` changes, subject should describe the problem, not the solution (e.g. `fix(cli): intermediate.js file not found` instead of ~`fix(cli): make sure output directory exists`~).
+  - For `feat` changes, subject should describe the feature, not the activity of adding the feature (e.g. `feat(sdk): google cloud platform support` instead of `feat(sdk): add tf-gcp target to sdk`).
+  - For `rfc` changes, subject should be the title of the rfc (e.g. `rfc(cli): run command` instead
     of `rfc(cli): rfc for run cli run command`).
 
 ### How to run tests for all operating systems in pull requests
 
 In pull requests, by default we only run tests for the same operating system and Node version that we build with (Linux, Node 18 currently).
 
-If you want to run tests for all operating systems, you can add the `🧪 pr/e2e-full` label to your PR. 
+If you want to run tests for all operating systems, you can add the `🧪 pr/e2e-full` label to your PR.
 This label must be present before the build job starts, so if you add it after the build job has started, you will need to re-trigger the build by pushing a new commit to your PR.
 
 ## 🧪 How do I set up my PRs to update snapshots?

docs/docs/04-standard-library/01-cloud/bucket.md

@@ -548,7 +548,7 @@ Check failures on the method and retrieve errors if any.
 
 ### BucketEvent <a name="BucketEvent" id="@winglang/sdk.cloud.BucketEvent"></a>
 
-on_event notification payload- will be in use after solving issue: https://github.com/winglang/wing/issues/1927.
+`onEvent` notification payload.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.cloud.BucketEvent.Initializer"></a>
 
@@ -562,8 +562,8 @@ let BucketEvent = cloud.BucketEvent{ ... };
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@winglang/sdk.cloud.BucketEvent.property.key">key</a></code> | <code>str</code> | the bucket key that triggered the event. |
-| <code><a href="#@winglang/sdk.cloud.BucketEvent.property.type">type</a></code> | <code><a href="#@winglang/sdk.cloud.BucketEventType">BucketEventType</a></code> | type of event. |
+| <code><a href="#@winglang/sdk.cloud.BucketEvent.property.key">key</a></code> | <code>str</code> | The bucket key that triggered the event. |
+| <code><a href="#@winglang/sdk.cloud.BucketEvent.property.type">type</a></code> | <code><a href="#@winglang/sdk.cloud.BucketEventType">BucketEventType</a></code> | Type of event. |
 
 ---
 
@@ -575,7 +575,7 @@ key: str;
 
 - *Type:* str
 
-the bucket key that triggered the event.
+The bucket key that triggered the event.
 
 ---
 
@@ -587,13 +587,13 @@ type: BucketEventType;
 
 - *Type:* <a href="#@winglang/sdk.cloud.BucketEventType">BucketEventType</a>
 
-type of event.
+Type of event.
 
 ---
 
 ### BucketOnCreateProps <a name="BucketOnCreateProps" id="@winglang/sdk.cloud.BucketOnCreateProps"></a>
 
-on create event options.
+`onCreate` event options.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.cloud.BucketOnCreateProps.Initializer"></a>
 
@@ -606,7 +606,7 @@ let BucketOnCreateProps = cloud.BucketOnCreateProps{ ... };
 
 ### BucketOnDeleteProps <a name="BucketOnDeleteProps" id="@winglang/sdk.cloud.BucketOnDeleteProps"></a>
 
-on delete event options.
+`onDelete` event options.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.cloud.BucketOnDeleteProps.Initializer"></a>
 
@@ -619,7 +619,7 @@ let BucketOnDeleteProps = cloud.BucketOnDeleteProps{ ... };
 
 ### BucketOnEventProps <a name="BucketOnEventProps" id="@winglang/sdk.cloud.BucketOnEventProps"></a>
 
-on any event options.
+`onEvent` options.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.cloud.BucketOnEventProps.Initializer"></a>
 
@@ -632,7 +632,7 @@ let BucketOnEventProps = cloud.BucketOnEventProps{ ... };
 
 ### BucketOnUpdateProps <a name="BucketOnUpdateProps" id="@winglang/sdk.cloud.BucketOnUpdateProps"></a>
 
-on update event options.
+`onUpdate` event options.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.cloud.BucketOnUpdateProps.Initializer"></a>
 
@@ -761,35 +761,35 @@ Function that will be called when an event notification is fired.
 
 ### BucketEventType <a name="BucketEventType" id="@winglang/sdk.cloud.BucketEventType"></a>
 
-bucket events to subscribe to.
+Bucket events to subscribe to.
 
 #### Members <a name="Members" id="Members"></a>
 
 | **Name** | **Description** |
 | --- | --- |
-| <code><a href="#@winglang/sdk.cloud.BucketEventType.CREATE">CREATE</a></code> | create. |
-| <code><a href="#@winglang/sdk.cloud.BucketEventType.DELETE">DELETE</a></code> | delete. |
-| <code><a href="#@winglang/sdk.cloud.BucketEventType.UPDATE">UPDATE</a></code> | update. |
+| <code><a href="#@winglang/sdk.cloud.BucketEventType.CREATE">CREATE</a></code> | Create. |
+| <code><a href="#@winglang/sdk.cloud.BucketEventType.DELETE">DELETE</a></code> | Delete. |
+| <code><a href="#@winglang/sdk.cloud.BucketEventType.UPDATE">UPDATE</a></code> | Update. |
 
 ---
 
 ##### `CREATE` <a name="CREATE" id="@winglang/sdk.cloud.BucketEventType.CREATE"></a>
 
-create.
+Create.
 
 ---
 
 
 ##### `DELETE` <a name="DELETE" id="@winglang/sdk.cloud.BucketEventType.DELETE"></a>
 
-delete.
+Delete.
 
 ---
 
 
 ##### `UPDATE` <a name="UPDATE" id="@winglang/sdk.cloud.BucketEventType.UPDATE"></a>
 
-update.
+Update.
 
 ---
 

docs/docs/04-standard-library/02-std/api-reference.md

@@ -291,7 +291,7 @@ Create a Datetime from UTC timezone.
 | <code><a href="#@winglang/sdk.std.Datetime.property.sec">sec</a></code> | <code>num</code> | Returns the seconds of the local machine time or in utc. |
 | <code><a href="#@winglang/sdk.std.Datetime.property.timestamp">timestamp</a></code> | <code>num</code> | Return a timestamp of non-leap year seconds since epoch. |
 | <code><a href="#@winglang/sdk.std.Datetime.property.timestampMs">timestampMs</a></code> | <code>num</code> | Return a timestamp of non-leap year milliseconds since epoch. |
-| <code><a href="#@winglang/sdk.std.Datetime.property.timezone">timezone</a></code> | <code>num</code> | returns the offset in minutes from UTC. |
+| <code><a href="#@winglang/sdk.std.Datetime.property.timezone">timezone</a></code> | <code>num</code> | Returns the offset in minutes from UTC. |
 | <code><a href="#@winglang/sdk.std.Datetime.property.year">year</a></code> | <code>num</code> | Returns the year of the local machine time or in utc. |
 
 ---
@@ -412,7 +412,7 @@ timezone: num;
 
 - *Type:* num
 
-returns the offset in minutes from UTC.
+Returns the offset in minutes from UTC.
 
 ---
 
@@ -2055,7 +2055,7 @@ The length of the string.
 
 ### DatetimeComponents <a name="DatetimeComponents" id="@winglang/sdk.std.DatetimeComponents"></a>
 
-interface that is used for setting Datetime date.
+Interface that is used for setting Datetime date.
 
 #### Initializer <a name="Initializer" id="@winglang/sdk.std.DatetimeComponents.Initializer"></a>
 
@@ -2067,14 +2067,14 @@ let DatetimeComponents = DatetimeComponents{ ... };
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.day">day</a></code> | <code>num</code> | day. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.hour">hour</a></code> | <code>num</code> | hours. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.min">min</a></code> | <code>num</code> | minutes. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.month">month</a></code> | <code>num</code> | month. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.ms">ms</a></code> | <code>num</code> | milliseconds. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.sec">sec</a></code> | <code>num</code> | seconds. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.tz">tz</a></code> | <code>num</code> | timezone offset in minutes from UTC. |
-| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.year">year</a></code> | <code>num</code> | year. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.day">day</a></code> | <code>num</code> | Day. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.hour">hour</a></code> | <code>num</code> | Hours. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.min">min</a></code> | <code>num</code> | Minutes. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.month">month</a></code> | <code>num</code> | Month. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.ms">ms</a></code> | <code>num</code> | Milliseconds. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.sec">sec</a></code> | <code>num</code> | Seconds. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.tz">tz</a></code> | <code>num</code> | Timezone offset in minutes from UTC. |
+| <code><a href="#@winglang/sdk.std.DatetimeComponents.property.year">year</a></code> | <code>num</code> | Year. |
 
 ---
 
@@ -2086,7 +2086,7 @@ day: num;
 
 - *Type:* num
 
-day.
+Day.
 
 ---
 
@@ -2098,7 +2098,7 @@ hour: num;
 
 - *Type:* num
 
-hours.
+Hours.
 
 ---
 
@@ -2110,7 +2110,7 @@ min: num;
 
 - *Type:* num
 
-minutes.
+Minutes.
 
 ---
 
@@ -2122,7 +2122,7 @@ month: num;
 
 - *Type:* num
 
-month.
+Month.
 
 ---
 
@@ -2134,7 +2134,7 @@ ms: num;
 
 - *Type:* num
 
-milliseconds.
+Milliseconds.
 
 ---
 
@@ -2146,7 +2146,7 @@ sec: num;
 
 - *Type:* num
 
-seconds.
+Seconds.
 
 ---
 
@@ -2158,7 +2158,7 @@ tz: num;
 
 - *Type:* num
 
-timezone offset in minutes from UTC.
+Timezone offset in minutes from UTC.
 
 ---
 
@@ -2170,7 +2170,7 @@ year: num;
 
 - *Type:* num
 
-year.
+Year.
 
 ---
 

docs/docs/04-standard-library/03-http/api-reference.md

@@ -16,7 +16,7 @@ sidebar_position: 100
 
 ### Http <a name="Http" id="@winglang/sdk.http.Util"></a>
 
-the Http class is used for calling different HTTP methods and requesting and sending information online,  as well as testing public accessible resources.
+The Http class is used for calling different HTTP methods and requesting and sending information online,  as well as testing public accessible resources.
 
 
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
@@ -214,7 +214,7 @@ let RequestOptions = http.RequestOptions{ ... };
 | <code><a href="#@winglang/sdk.http.RequestOptions.property.cache">cache</a></code> | <code><a href="#@winglang/sdk.http.RequestCache">RequestCache</a></code> | The cache mode you want to use for the request. |
 | <code><a href="#@winglang/sdk.http.RequestOptions.property.headers">headers</a></code> | <code>MutMap&lt;str&gt;</code> | Any headers you want to add to your request. |
 | <code><a href="#@winglang/sdk.http.RequestOptions.property.method">method</a></code> | <code><a href="#@winglang/sdk.http.HttpMethod">HttpMethod</a></code> | The request method, e.g., GET, POST. The default is GET. |
-| <code><a href="#@winglang/sdk.http.RequestOptions.property.redirect">redirect</a></code> | <code><a href="#@winglang/sdk.http.RequestRedirect">RequestRedirect</a></code> | he redirect mode to use: follow, error. |
+| <code><a href="#@winglang/sdk.http.RequestOptions.property.redirect">redirect</a></code> | <code><a href="#@winglang/sdk.http.RequestRedirect">RequestRedirect</a></code> | Redirect mode to use: follow, error. |
 | <code><a href="#@winglang/sdk.http.RequestOptions.property.referrer">referrer</a></code> | <code>str</code> | A string specifying "no-referrer", client, or a URL. |
 
 ---
@@ -279,7 +279,7 @@ redirect: RequestRedirect;
 - *Type:* <a href="#@winglang/sdk.http.RequestRedirect">RequestRedirect</a>
 - *Default:* follow
 
-he redirect mode to use: follow, error.
+Redirect mode to use: follow, error.
 
 The default is follow.