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

Add lock(f, lock) docstring to lock. #33796

Merged
merged 1 commit into from
Nov 9, 2019
Merged

Add lock(f, lock) docstring to lock. #33796

merged 1 commit into from
Nov 9, 2019

Conversation

NHDaly
Copy link
Member

@NHDaly NHDaly commented Nov 8, 2019

Currently the lock(l) do ; ... end method is not documented, and so is not discoverable.

@NHDaly
Add lock(f, lock) docstring to lock.
310daa9 
Currently the `lock(l) do ; ... end` method is not documented, and so
is not discoverable.
c42f
c42f approved these changes Nov 9, 2019
View reviewed changes
Copy link
Member

@c42f c42f left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@c42f c42f merged commit 8c34ad3 into JuliaLang:master Nov 9, 2019
@timholy
Copy link
Sponsor Member

timholy commented Nov 9, 2019

Is it problematic that the verb lock is the same word as the object lock? I know that's not unique to this docstring. #25092 changed it from the_lock to just lock.

@c42f
Copy link
Member

c42f commented Nov 9, 2019

I do think it's fairly confusing, though this PR is consistent from elsewhere. We could rename the noun to lk,L, the_lock, alock? for those methods where it matters.

@NHDaly
Copy link
Member Author

NHDaly commented Nov 10, 2019

Is it problematic that the verb lock is the same word as the object lock?

+1 I thought that was weird too. I think l would also be fine, especially since that's what the parameter is actually named in the method.

@NHDaly NHDaly deleted the nhd-document-lock-f branch November 10, 2019 15:52
KristofferC pushed a commit that referenced this pull request Apr 11, 2020
@NHDaly @KristofferC
Add lock(f, lock) docstring to lock. (#33796)
5b40bfd 
Currently the `lock(l) do ; ... end` method is not documented, and so
is not discoverable.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@c42f c42f c42f approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@NHDaly @timholy @c42f