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

Document fields of PushOptions #22564

Merged
merged 1 commit into from
Jun 29, 2017
Merged

Document fields of PushOptions #22564

merged 1 commit into from
Jun 29, 2017

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Jun 27, 2017

No description provided.

@kshyatt kshyatt added docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module labels Jun 27, 2017
@kshyatt kshyatt requested a review from ararslan June 27, 2017 03:00
@kshyatt kshyatt mentioned this pull request Jun 27, 2017
Closed
tkelman
tkelman reviewed Jun 27, 2017
View reviewed changes
base/libgit2/types.jl
Sets options for using a proxy to communicate with a remote. See [`ProxyOptions`](@ref)
for more information.
* `custom_headers`: only relevant if the LibGit2 version is greater than or equal to `0.24.0`.
Extra headers needed for the push operation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe link to libgit2 docs for what this means?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the docs for this function they don't elaborate any more than this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that ok, or should i go on a hunt to flesh this out?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should maybe be documenting what type each of the fields are for struct docs like this, but sounds like this is obscure enough that there's no common use case for it

@kshyatt kshyatt merged commit 940b2e6 into master Jun 29, 2017
@kshyatt kshyatt deleted the ksh/docpushopt branch June 29, 2017 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkelman tkelman tkelman left review comments

@ararslan ararslan ararslan approved these changes

Assignees
No one assigned
Labels
docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kshyatt @tkelman @ararslan