More doctests and cleanup for intfuncs #22515

kshyatt · 2017-06-24T21:29:23Z

No description provided.

tkelman · 2017-06-24T23:35:19Z

base/docs/helpdb/Base.jl

+
+# Examples
+```jldoctest
+julia> get(d, "a", 3)


does this pass? where does d come from?

whoops, forgot to copy paste

KristofferC

LGTM after one read through. It overlaps a bit with #22289 but no problems.

KristofferC · 2017-06-25T03:05:19Z

Think this should be valid to backport.

tkelman · 2017-06-25T14:22:35Z

base/array.jl


-```julia-repl
 julia> resize!([6, 5, 4, 3, 2, 1], 8)


this isn't guaranteed to always be zero-initialized beyond the end of the array, is it?

No, I guess thats why this wasn't a doctest.

tkelman · 2017-06-25T14:49:52Z

base/docs/helpdb/Base.jl

@@ -1772,11 +1967,12 @@ Return the value stored for the given key, or if no mapping for the key is prese
 `key => f()`, and return `f()`.

 This is intended to be called using `do` block syntax:
-
+```julia
 get!(dict, key) do


if fenced with triple backticks, then shouldn't be indented any more

tkelman · 2017-06-25T14:51:08Z

base/docs/helpdb/Base.jl

+# Examples
+
+```jldoctest
+julia> searchsortedlast([1, 2, 4, 5, 4], 4)


examples for this function should use sorted inputs, that's what it's designed for

tkelman · 2017-06-25T15:34:30Z

base/docs/helpdb/Base.jl

@@ -2124,6 +2338,14 @@ throw
 ⊊(a,b) -> Bool

 Determine whether every element of `a` is also in `b`, using [`in`](@ref).
+
+```jldoctest


# Examples

tkelman · 2017-06-25T17:25:49Z

base/sparse/sparsematrix.jl

+
+# Example
+```jldoctest
+julia> Base.SparseArrays.dropstored!(A, [1, 2], [1, 1])


where does A come from?

kshyatt · 2017-06-26T17:13:06Z

OK to go?

tkelman · 2017-06-26T17:18:02Z

base/array.jl

- 1
- 0
- 0
+ julia> a = resize!([6, 5, 4, 3, 2, 1], 8);


looks like there's an extra leading space in this block

Fixed, and I ran make check-whitespace locally.

~~how strange, I see bdbcbba from a fetch, but github isn't showing it in the pr yet?~~ problem on github's side https://status.github.com/

Sacha0 · 2017-06-26T18:43:34Z

base/docs/helpdb/Base.jl

@@ -483,6 +499,23 @@ Returns the range of indices of `a` which compare as equal to `x` (using binary
 according to the order specified by the `by`, `lt` and `rev` keywords, assuming that `a`
 is already sorted in that order. Returns an empty range located at the insertion point
 if `a` does not contain values equal to `x`.
+
+# Examples
+


Extra empty line?

Sacha0 · 2017-06-26T18:46:10Z

base/docs/helpdb/Base.jl

@@ -786,6 +859,48 @@ at the position where it would appear if the array were fully sorted via a non-s
 algorithm. If `k` is a single index, that value is returned; if `k` is a range, an array of
 values at those indices is returned. Note that `select!` does not fully sort the input
 array.
+
+# Examples
+


Extra empty line here as well? (Have we a convention for absence/presence of an extra empty line following # Example[s]? Remarked here and above for consistency with the absence earlier in this PR, but have no preference.)

we should pick and standardize - personally I lean towards leaving out the empty line, assuming it should render the same

I agree but I think we should a) pick one and b) have one mega-PR to fix it everywhere (much like @StefanKarpinski did with the @test_approx_eq macro).

Sounds good! :) (Small PRs are nice though!)

Sacha0 · 2017-06-26T18:48:52Z

base/docs/helpdb/Base.jl

+ 3
+ 2
+ 1
+```


Perhaps an example illustrating the partial sorting behavior would be worthwhile? The examples above yield fully sorted results.

Sacha0 · 2017-06-26T18:49:22Z

base/docs/helpdb/Base.jl

@@ -795,6 +910,15 @@ select!
 Create a random ASCII string of length `len`, consisting of upper- and
 lower-case letters and the digits 0-9. The optional `rng` argument
 specifies a random number generator, see [Random Numbers](@ref).
+
+# Example
+


See extra empty line question above :).

Sacha0 · 2017-06-26T18:51:17Z

base/docs/helpdb/Base.jl

@@ -1179,6 +1345,20 @@ delete!

 Returns the index of the first value in `a` greater than or equal to `x`, according to the
 specified order. Returns `length(a)+1` if `x` is greater than all values in `a`.
+`a` is assuemd to be sorted.


assuemd? :)

Sacha0 · 2017-06-26T18:51:44Z

base/docs/helpdb/Base.jl

+`a` is assuemd to be sorted.
+
+# Examples
+


See question above re. empty lines :).

Sacha0 · 2017-06-26T18:59:26Z

base/multidimensional.jl

@@ -111,6 +142,18 @@ module IteratorsMD

 Consequently these can be useful for writing algorithms that
 work in arbitrary dimensions.
+


Perhaps an # Example heading?

this wasn't addressed?

Sacha0

The new examples are a wonderful addition! :)

kshyatt · 2017-06-27T01:10:57Z

Unless someone requests changes or beats me, I'm going to merge in the morning :)

* More doctests and cleanup for intfuncs * Also more doctests for arrays * More doctests and Example{s} inserting * Doctests for DAYS * Fix some failing doctests * "fix" failing OffsetArray test * Address more comments * fix dropstored! * Fix leading space * fix typo Ref #22515 (cherry picked from commit de74614)

* More doctests and cleanup for intfuncs * Also more doctests for arrays * More doctests and Example{s} inserting * Doctests for DAYS * Fix some failing doctests * "fix" failing OffsetArray test * Address more comments * fix dropstored! * Fix leading space * fix typo (cherry picked from commit de74614)

kshyatt added domain:docs This change adds or pertains to documentation test This change adds or pertains to unit tests labels Jun 24, 2017

kshyatt requested a review from KristofferC June 24, 2017 21:29

tkelman reviewed Jun 24, 2017

View reviewed changes

tkelman assigned tkelman and unassigned tkelman Jun 25, 2017

tkelman self-requested a review June 25, 2017 01:43

KristofferC approved these changes Jun 25, 2017

View reviewed changes

KristofferC mentioned this pull request Jun 25, 2017

doc improvements #22289

Merged

KristofferC added the backport pending 0.6 label Jun 25, 2017

kshyatt added 6 commits June 25, 2017 07:17

More doctests and cleanup for intfuncs

ebc1a90

Also more doctests for arrays

d086039

More doctests and Example{s} inserting

20e24b2

Doctests for DAYS

ba4fc8c

Fix some failing doctests

4613c2c

"fix" failing OffsetArray test

d7147b7

kshyatt force-pushed the ksh/doctestint branch from e9c9f30 to d7147b7 Compare June 25, 2017 14:17

tkelman reviewed Jun 25, 2017

View reviewed changes

Address more comments

b8c07f8

tkelman reviewed Jun 25, 2017

View reviewed changes

fix dropstored!

d44b9ce

tkelman reviewed Jun 26, 2017

View reviewed changes

[ci skip] Fix leading space

bdbcbba

Sacha0 reviewed Jun 26, 2017

View reviewed changes

base/docs/helpdb/Base.jl Outdated

`a` is assuemd to be sorted.

# Examples

Copy link

Member

Sacha0 Jun 26, 2017

Choose a reason for hiding this comment

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

See question above re. empty lines :).

[ci skip] fix typo

0c9f297

Sacha0 reviewed Jun 26, 2017

View reviewed changes

Sacha0 approved these changes Jun 26, 2017

View reviewed changes

KristofferC merged commit de74614 into master Jun 27, 2017

kshyatt deleted the ksh/doctestint branch June 27, 2017 03:01

ararslan removed the backport pending 0.6 label Oct 7, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More doctests and cleanup for intfuncs #22515

More doctests and cleanup for intfuncs #22515

kshyatt commented Jun 24, 2017

tkelman Jun 24, 2017

kshyatt Jun 24, 2017

KristofferC left a comment

KristofferC commented Jun 25, 2017

tkelman Jun 25, 2017

fredrikekre Jun 25, 2017

tkelman Jun 25, 2017

tkelman Jun 25, 2017

tkelman Jun 25, 2017

tkelman Jun 25, 2017

kshyatt commented Jun 26, 2017

tkelman Jun 26, 2017

kshyatt Jun 26, 2017

tkelman Jun 26, 2017 •

edited

Loading

Sacha0 Jun 26, 2017

Sacha0 Jun 26, 2017

tkelman Jun 26, 2017

kshyatt Jun 26, 2017

Sacha0 Jun 26, 2017 •

edited

Loading

Sacha0 Jun 26, 2017

Sacha0 Jun 26, 2017

Sacha0 Jun 26, 2017

kshyatt Jun 26, 2017

Sacha0 Jun 26, 2017

Sacha0 Jun 26, 2017

tkelman Jun 27, 2017

KristofferC Jun 27, 2017

Sacha0 left a comment

kshyatt commented Jun 27, 2017

+
+
+
+```

		@@ -111,6 +142,18 @@ module IteratorsMD

		Consequently these can be useful for writing algorithms that
		work in arbitrary dimensions.

More doctests and cleanup for intfuncs #22515

More doctests and cleanup for intfuncs #22515

Conversation

kshyatt commented Jun 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KristofferC left a comment

Choose a reason for hiding this comment

KristofferC commented Jun 25, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kshyatt commented Jun 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkelman Jun 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sacha0 Jun 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sacha0 left a comment

Choose a reason for hiding this comment

kshyatt commented Jun 27, 2017

tkelman Jun 26, 2017 •

edited

Loading

Sacha0 Jun 26, 2017 •

edited

Loading