Skip to content

Commit

Permalink
Add comments for CredentialPayload allow fields
Browse files Browse the repository at this point in the history
  • Loading branch information
omus committed Sep 15, 2017
1 parent c902aa6 commit 8c466d1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions base/libgit2/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1147,15 +1147,15 @@ end
"""
LibGit2.CredentialPayload
Retains state between multiple calls to the credential callback. A single
`CredentialPayload` instance will be used when authentication fails for a URL but different
instances will be used when the URL has changed.
Retains the state between multiple calls to the credential callback for the same URL.
A `CredentialPayload` instance is expected to be `reset!` whenever it will be used with a
different URL.
"""
mutable struct CredentialPayload <: Payload
explicit::Nullable{AbstractCredentials}
cache::Nullable{CachedCredentials}
allow_ssh_agent::Bool
allow_prompt::Bool
allow_ssh_agent::Bool # Allow the use of the SSH agent to get credentials
allow_prompt::Bool # Allow prompting the user for credentials

# Ephemeral state fields
credential::Nullable{AbstractCredentials}
Expand Down

0 comments on commit 8c466d1

Please sign in to comment.