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

More HelpDB pruning for Bit/SparseArray, more examples #17797

Merged
merged 5 commits into from
Aug 6, 2016
Merged

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Aug 3, 2016

Yet MORE examples from the REPL. Fixed and added links,
changd some wording.

@kshyatt kshyatt added docs This change adds or pertains to documentation sparse Sparse arrays labels Aug 3, 2016
@Sacha0
Copy link
Member

Sacha0 commented Aug 4, 2016

Scanning rapidly, the sparse-related changes lgtm!

"""
ror!(dest::BitVector, src::BitVector, i::Integer) -> BitVector

Performs a right rotation operation on `src` and put the result into `dest`.
Copy link
Contributor

Choose a reason for hiding this comment

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

and puts the result

@kshyatt
Copy link
Contributor Author

kshyatt commented Aug 5, 2016

Rebased against master - all doctests pass locally.

@@ -187,7 +187,7 @@ Constructors

Create an array of all zeros with the same element type and shape as ``A``\ .

.. function:: ones([T::Type=Float64,] dims)
.. function:: ones(type, dims)
Copy link
Contributor

Choose a reason for hiding this comment

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

eltype?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I restored this back to the way it was originally. Getting this to work with the @eval loop was basically impossible because sysimg.jl loads string.jl after array.jl.

Copy link
Contributor

Choose a reason for hiding this comment

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

you can always add empty signatures outside the loop just for the purpose of attaching the docstring?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried that and it didn't work, because we have two ones methods.

Copy link
Contributor

Choose a reason for hiding this comment

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

there should be a syntax to attach the same docstring to 2 methods

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, you have it backwards. We have two docstrings for one method if you use the empty signatures.

@kshyatt
Copy link
Contributor Author

kshyatt commented Aug 6, 2016

make check-whitespace passes on this latest.

@tkelman tkelman merged commit ec15da7 into master Aug 6, 2016
@tkelman tkelman deleted the ksh/docfunarray branch August 6, 2016 08:14
tkelman pushed a commit that referenced this pull request Aug 11, 2016
Yet MORE examples from the REPL. Fixed and added links,
changd some wording.

(cherry picked from commit e4a377c)
ref #17797
tkelman pushed a commit that referenced this pull request Aug 11, 2016
Removed calls to `rand` in the doctests.

(cherry picked from commit 6df3ec0)
ref #17797
tkelman pushed a commit that referenced this pull request Aug 11, 2016
(cherry picked from commit 071cd66)
ref #17797
tkelman pushed a commit that referenced this pull request Aug 11, 2016
(cherry picked from commit fdef48d)
ref #17797
tkelman pushed a commit that referenced this pull request Aug 11, 2016
(cherry picked from commit 6ffe1ab)
ref #17797
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 sparse Sparse arrays
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants