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

Clear out even MORE helpdb docs #19813

Closed
wants to merge 1 commit into from
Closed

Clear out even MORE helpdb docs #19813

wants to merge 1 commit into from

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Jan 2, 2017

No description provided.

@kshyatt kshyatt added the docs This change adds or pertains to documentation label Jan 2, 2017
m = read(s, Int)
n = read(s, Int)
A2 = Mmap.mmap(s, Matrix{Int}, (m,n))
```
Copy link
Member

Choose a reason for hiding this comment

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

Should this be turned into a doctest? Might need to use mktemp instead of hardcoding a file name though.

@MichaelHatherly
Copy link
Member

Looks like some of the signatures in stdlib will need adjusting: https://travis-ci.org/JuliaLang/julia/jobs/188176839#L745.

@tkelman tkelman self-requested a review January 3, 2017 04:14
@kshyatt
Copy link
Contributor Author

kshyatt commented Jan 4, 2017

Everyone: please hold off on merging this until #19674 is merged :)

@KristofferC
Copy link
Member

It now is.

@@ -225,6 +225,7 @@ See [`RoundingMode`](@ref) for available rounding modes.
Float32

"""
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

still being moved, should still be deleted here right?

Copy link
Contributor

Choose a reason for hiding this comment

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

there are 2 or 3 more of these

reverse(v, start=1, stop=length(v))

Return a copy of `v` reversed from start to stop.
"""
function reverse(A::AbstractVector, s=1, n=length(A))
Copy link
Member

Choose a reason for hiding this comment

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

Aside: the arg names do not match and it seems like 'stop' is incorrect terminology here...

@@ -557,6 +485,7 @@ Determine whether Julia is running an interactive session.
isinteractive

"""
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

should be removed from this file

@kshyatt
Copy link
Contributor Author

kshyatt commented Jan 6, 2017

I think I got all the merge artifacts out. Good to go?

@@ -232,7 +232,6 @@ Base.varm
Base.middle
Base.median
Base.median!
Base.midpoints
Copy link
Contributor

Choose a reason for hiding this comment

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

this is in deprecated.jl but not actually deprecated, it still has tests even. we should move it to the 0.6 section, make it an actual deprecation, and remove the export and tests

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you want me to do that now, or in a separate PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't remove its docs until it's actually deprecated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, fixed?

Copy link
Contributor

Choose a reason for hiding this comment

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

except for this line?

@kshyatt kshyatt force-pushed the ksh/helpdb branch 2 times, most recently from 61c3de1 to 3d272c6 Compare January 6, 2017 22:14
@@ -165,6 +231,20 @@ mmap{T<:Array}(file::AbstractString, ::Type{T}, len::Integer, offset::Integer=In
mmap{T<:Array,N}(::Type{T}, dims::NTuple{N,Integer}; shared::Bool=true) = mmap(Anonymous(), T, dims, Int64(0); shared=shared)
mmap{T<:Array}(::Type{T}, i::Integer...; shared::Bool=true) = mmap(Anonymous(), T, convert(Tuple{Vararg{Int}},i), Int64(0); shared=shared)

"""
Mmap.mmap(io, BitArray, dims, offset)
Copy link
Contributor

Choose a reason for hiding this comment

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

offset has a default, does dims?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

dims does not

a `MethodError` if this type is not supported by either the display(s) or by `x`. With these
variants, one can also supply the "raw" data in the requested MIME type by passing
`x::AbstractString` (for MIME types with text-based storage, such as text/html or
application/postscript) or `x::Vector{UInt8}` (for binary MIME types).
Copy link
Contributor

Choose a reason for hiding this comment

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

should text/html and application/postscript be code-highlighted?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, they are in the reprmime docstring

"""
Mmap.mmap(io, ::BitArray, dims = ?, offset = ?)

"""
bessely0(x)
Copy link
Contributor

Choose a reason for hiding this comment

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

should delete this one here

@@ -1441,6 +1441,13 @@ function randsubseq!(r::AbstractRNG, S::AbstractArray, A::AbstractArray, p::Real
end
return S
end

"""
randsubseq!(S, A, p::Real)
Copy link
Contributor

Choose a reason for hiding this comment

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

you didn't delete this one from helpdb?

@kshyatt kshyatt closed this Jul 18, 2017
@kshyatt kshyatt deleted the ksh/helpdb branch July 18, 2017 22:14
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants