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

Add WeakRef to docs_main #3926

Closed
wants to merge 1 commit into from
Closed

Add WeakRef to docs_main #3926

wants to merge 1 commit into from

Conversation

RX14
Copy link
Contributor

@RX14 RX14 commented Jan 21, 2017

WeakRef wasn't showing up in the documentation, but it's not :nodoc: so I assume this is not intended.

@luislavena
Copy link
Contributor

@RX14 there isn't much documentation defined in WeakRef currently to make it worth of addition.

Perhaps adding an example on usage to the docs will make it better?

Thank you.

@RX14
Copy link
Contributor Author

RX14 commented Apr 14, 2017

I've added some docs to WeakRef, although I wasn't sure exactly how to document WeakRef.allocate. It seems to be for structs, using malloc_atomic to ensure that any pointers in the struct are "weak references", but as it doesn't change the type of the members that would be pretty unsafe. Should it be :nodoc:?

@bcardiff
Copy link
Member

@RX14 yes, :nodoc: seems fine for .allocate

@bcardiff bcardiff closed this in 24c8321 Apr 20, 2017
@bcardiff
Copy link
Member

@RX14 I include manually these changes updating them w.r.t #4293.

@bcardiff bcardiff added this to the Next milestone Apr 20, 2017
@RX14
Copy link
Contributor Author

RX14 commented Apr 20, 2017

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants