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

Group docs and fix visibility #57

Merged
merged 3 commits into from
Jan 17, 2025
Merged

Group docs and fix visibility #57

merged 3 commits into from
Jan 17, 2025

Conversation

glbrntt
Copy link
Collaborator

@glbrntt glbrntt commented Jan 16, 2025

Motivation:

Grouping docs in the DocC index is a useful way to make the docs more approachable.

Modifications:

  • Group the docs
  • Add a few more docs
  • Change the visibility of an accidentally public type

Result:

Better docs

Motivation:

Grouping docs in the DocC index is a useful way to make the docs more
approachable.

Modifications:

- Group the docs
- Add a few more docs
- Change the visibility of an accidentally public type

Result:

Better docs
@glbrntt glbrntt added the 🔨 semver/patch No public API change. label Jan 16, 2025
@glbrntt
Copy link
Collaborator Author

glbrntt commented Jan 16, 2025

This is technically an API break because a public type was made package but there were no public inits so the chance of this actually breaking is close to zero.

@glbrntt glbrntt requested a review from gjcairo January 16, 2025 13:00
@glbrntt glbrntt enabled auto-merge (squash) January 16, 2025 13:33
@glbrntt glbrntt merged commit e4bf649 into grpc:main Jan 17, 2025
22 of 28 checks passed
@glbrntt glbrntt deleted the docs branch January 17, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants