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

Document struct field names in stream.go #5359

Merged
merged 2 commits into from Apr 30, 2024
Merged

Document struct field names in stream.go #5359

merged 2 commits into from Apr 30, 2024

Conversation

jnmoyne
Copy link
Contributor

@jnmoyne jnmoyne commented Apr 26, 2024

  • Add comments to document main structure field names a bit better and improve the code accessibility.
  • Rename setSourceConsumer to setupSourceConsumer (better and matches setupMirrorConsumer).

Signed-off-by: Jean-Noël Moyne jnmoyne@gmail.com

@jnmoyne jnmoyne requested a review from a team as a code owner April 26, 2024 07:32
@jnmoyne jnmoyne force-pushed the jnm/comments1 branch 3 times, most recently from 5760bf3 to 675e1cb Compare April 26, 2024 07:47
@yordis
Copy link

yordis commented Apr 26, 2024

Thank you for doing this!

As someone external to the Nats Core team who code reviews every PR acquiring knowledge, this is really valuable.

I wish the codebase had become more verbose in terms of spelling names and introduced even more types to reflect the domain as well 🙏🏻 Regardless, this is super valuable!

Copy link
Member

@derekcollison derekcollison left a comment

Choose a reason for hiding this comment

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

Generally looks good, one minor correction needed.

server/stream.go Outdated Show resolved Hide resolved
Copy link
Member

@derekcollison derekcollison left a comment

Choose a reason for hiding this comment

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

LGTM

@derekcollison
Copy link
Member

Hey @jnmoyne can you rebase on top of main and resolve one conflict with your sourcing change?

@derekcollison
Copy link
Member

Once resolved I will pull in.

…improve the code accessibility.

Rename setSourceConsumer to setupSourceConsumer (better and matches setupMirrorConsumer).

Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>
Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>
@jnmoyne
Copy link
Contributor Author

jnmoyne commented Apr 30, 2024

Rebased

@derekcollison derekcollison merged commit b668c8a into main Apr 30, 2024
4 checks passed
@derekcollison derekcollison deleted the jnm/comments1 branch April 30, 2024 00:26
wallyqs pushed a commit that referenced this pull request May 1, 2024
- Add comments to document main structure field names a bit better and
improve the code accessibility.
- Rename setSourceConsumer to setupSourceConsumer (better and matches
setupMirrorConsumer).

Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>

---------

Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>
wallyqs pushed a commit that referenced this pull request May 1, 2024
- Add comments to document main structure field names a bit better and
improve the code accessibility.
- Rename setSourceConsumer to setupSourceConsumer (better and matches
setupMirrorConsumer).

Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>

---------

Signed-off-by: Jean-Noël Moyne <jnmoyne@gmail.com>
wallyqs added a commit that referenced this pull request May 1, 2024
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.

None yet

3 participants