Documentation: Deprecate old-style functions #403
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Author
|
@guelfey @jsouthworth - any feedback? |
kolyshkin
reviewed
Jul 29, 2025
Author
|
@kolyshkin updated the docs with your suggestion. |
Member
|
I disagree that these functions are "deprecated". Granted, they are likely not the ones that new users want to use, but they are required if you want to use a custom authentication mechanism, and by itself there is nothing wrong with that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I came here after encountering an application bug where it inadvertently closed a shared SystemBus connection. I bet a common mistake that is made after glancing through past issues.
After reviewing the library documentation and similar issues reported I decided to use the
SystemBusPrivatefunction. It was mentioned in #15 and an example was given here: #140 (ExampleSystemBusPrivate). I later realized that I was looking at go doc v4 documentation for the library (at pkg.go.dev) instead of the current latest v5 which include the Connect* methods introduced with #185.Since @jsouthworth mentioned that we could deprecate the old-style methods in favor of the new Connect* ones (#185 (comment)) I decided to help out so that others could avoid the pitfalls I came across and to make it clear which methods they should use.