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

Doc warn and warn_with #23441

Merged
merged 2 commits into from
Aug 29, 2017
Merged

Doc warn and warn_with #23441

merged 2 commits into from
Aug 29, 2017

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Aug 24, 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 Aug 24, 2017
@kshyatt kshyatt requested a review from simonbyrne August 24, 2017 23:28
@kshyatt kshyatt requested a review from ararslan August 27, 2017 15:26
@@ -849,6 +853,15 @@ end

with(f::Function, ::Type{T}, args...) where {T} = with(f, T(args...))

"""
with_warn(f::Function, ::Type{T}, args..)
Copy link
Member

Choose a reason for hiding this comment

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

Missing a trailing dot on args

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oooh good call

with_warn(f::Function, ::Type{T}, args..)

Resource management helper function. Apply `f` to `args`, first constructing
an instance of type `T` out of them. Makes sure to call `close` on the resulting
Copy link
Member

Choose a reason for hiding this comment

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

"Out of them" sounds confusing on first read. Maybe "first constructing an instance of type T using the given arguments"?

@kshyatt
Copy link
Contributor Author

kshyatt commented Aug 29, 2017

Looks like we had a Mac timeout. I find the CircleCI logs really hard to read - is the fail there my fault?

@ararslan
Copy link
Member

The Circle logs never even load for me (as an aside, that's why I made #23417, though that seems unlikely to be merged), so I'm also not sure. But I don't think Circle runs the doc stuff so it's likely unrelated.

@kshyatt kshyatt merged commit 109b0b4 into master Aug 29, 2017
@kshyatt kshyatt deleted the ksh/docwarn branch August 29, 2017 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation libgit2 The libgit2 library or the LibGit2 stdlib module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants