Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prefix comments with correct identifier name #498

Merged
merged 1 commit into from
Apr 21, 2023

Conversation

cuishuang
Copy link
Contributor

@cuishuang cuishuang commented Apr 21, 2023

To match typical Go style (even for unexported identifiers), the first word of most documentation comments should be the identifier name.

Signed-off-by: cui fliter <[email protected]>
Copy link
Member

@akshayjshah akshayjshah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fixes!

@akshayjshah akshayjshah changed the title fix some comments Prefix comments with correct identifier name Apr 21, 2023
@akshayjshah akshayjshah merged commit e04e4bd into connectrpc:main Apr 21, 2023
renovate bot referenced this pull request in open-feature/flagd May 31, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[github.com/bufbuild/connect-go](https://togithub.com/bufbuild/connect-go)
| require | minor | `v1.7.0` -> `v1.8.0` |

---

### Release Notes

<details>
<summary>bufbuild/connect-go</summary>

###
[`v1.8.0`](https://togithub.com/bufbuild/connect-go/releases/tag/v1.8.0)

[Compare
Source](https://togithub.com/bufbuild/connect-go/compare/v1.7.0...v1.8.0)

#### What's Changed

##### Enhancements

- Expose HTTP method of unary requests (see
[documentation][http-method-docs]) by
[@&#8203;jhump](https://togithub.com/jhump) and
[@&#8203;akshayjshah](https://togithub.com/akshayjshah) in
[https://github.com/bufbuild/connect-go/pull/502](https://togithub.com/bufbuild/connect-go/pull/502)
and
[https://github.com/bufbuild/connect-go/pull/509](https://togithub.com/bufbuild/connect-go/pull/509)
- Implement `fmt.Stringer` interface for StreamType to improve debug
logging by [@&#8203;svrana](https://togithub.com/svrana) in
[https://github.com/bufbuild/connect-go/pull/495](https://togithub.com/bufbuild/connect-go/pull/495)

##### Bugfixes

- Fix documentation comments to use correct identifier name by
[@&#8203;cuishuang](https://togithub.com/cuishuang) in
[https://github.com/bufbuild/connect-go/pull/498](https://togithub.com/bufbuild/connect-go/pull/498)
- Fix Makefile quotes to handle paths with spaces by
[@&#8203;bufdev](https://togithub.com/bufdev) in
[https://github.com/bufbuild/connect-go/pull/508](https://togithub.com/bufbuild/connect-go/pull/508)
- Always close response body in `CloseRead` by
[@&#8203;pkwarren](https://togithub.com/pkwarren) in
[https://github.com/bufbuild/connect-go/pull/515](https://togithub.com/bufbuild/connect-go/pull/515)

#### New Contributors

- [@&#8203;cuishuang](https://togithub.com/cuishuang) made their first
contribution in
[https://github.com/bufbuild/connect-go/pull/498](https://togithub.com/bufbuild/connect-go/pull/498)
- [@&#8203;svrana](https://togithub.com/svrana) made their first
contribution in
[https://github.com/bufbuild/connect-go/pull/495](https://togithub.com/bufbuild/connect-go/pull/495)

**Full Changelog**:
bufbuild/connect-go@v1.7.0...v1.8.0

[http-method-docs]:
https://connect.build/docs/go/get-requests-and-caching#distinguishing-get-requests

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/open-feature/flagd).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMDIuMTAiLCJ1cGRhdGVkSW5WZXIiOiIzNS4xMDIuMTAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
akshayjshah pushed a commit that referenced this pull request Jul 26, 2023
To match typical Go style (even for unexported identifiers), the first
word of most documentation comments should be the identifier name.

Signed-off-by: cui fliter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants