Skip to content

Commit

Permalink
fixup! Add first cut of git-credential-fdoss
Browse files Browse the repository at this point in the history
Make the description of NewSecretService clearer by linking to the spec
on "sessions" and qualifying the word "session" in the error case. Fix
typo.

Addresses: #3 (comment)
  • Loading branch information
camh- committed Aug 27, 2024
1 parent a54ee5f commit 00841bc
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions dbus.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,14 @@ type Secret struct {

// NewSecretService constructs and returns a SecretService for acting as a
// client on the DBus session bus to the Secret Service. It establishes a
// session with the secret service. The session is configured only with "plain"
// encryption currently (i.e. no encryption). Encrypted sessions are still to
// be implemented.
// [session] with the secret service. The session is configured only with
// "plain" encryption currently (i.e. no encryption). Encrypted sessions are
// still to be implemented.
//
// If the connection to DBus could not be established or the session could not
// be created, an error is retured instead.
// If the connection to DBus could not be established or if the secret service
// session could not be created, an error is returned instead.
//
// [session]: https://specifications.freedesktop.org/secret-service-spec/0.2/sessions.html
func NewSecretService() (*SecretService, error) {
conn, err := dbus.SessionBus()
if err != nil {
Expand Down

0 comments on commit 00841bc

Please sign in to comment.