Skip to content

Added some information about bitstype in doc #16242

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

Closed
wants to merge 1 commit into from
Closed

Added some information about bitstype in doc #16242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/manual/parallel-computing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,10 @@ arrays, a shared array is accessible only from those participating
workers specified by the ``pids`` named argument (and the creating
process too, if it is on the same host).

Note: If you want to store a Type like object, it must be immutable to count
as a [bitstype](http://docs.julialang.org/en/release-0.4/manual/types/).
Copy link
Contributor

Choose a reason for hiding this comment

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

The document is wrong here, it should be isbits not bitstype. Also, I believe you are using the markdown syntax instead of rst cross reference and you are linking the 0.4 doc here.

Copy link
Member

@quinnj quinnj May 19, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

@Skylion007, to clarify, the wording should be something along the lines of Note: only objects where "isbits(obj) == true" are supported. Then link to docs.julialang.org/en/latest/... instead of release-0.4. We can the backport the docs change to 0.4.

Attempting to store a mutable type object will result in an error.

If an ``init`` function, of signature ``initfn(S::SharedArray)``, is
specified, it is called on all the participating workers. You can
arrange it so that each worker runs the ``init`` function on a
Expand Down