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.

Sign up for GitHub

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

Jump to bottom

Isolate documentation for incidental public types #11

Open
samalone opened this issue Dec 11, 2023 · 0 comments
Open

Isolate documentation for incidental public types #11

samalone opened this issue Dec 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@samalone
Copy link
Owner

There are several types in the package that are public not because they are intended to be used directly, but because they are required to be public as part of the DistributedActorSystem protocol requirements. These include:

  • NIOInvocationEncoder
  • NIOInvocationDecoder
  • WebSocketActorSystemResultHandler

These types should be grouped into a section at the bottom of the top-level documentation so they don't distract from the primary APIs.
@samalone samalone added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@samalone