first pass at Documenter docs #59

cormullion · 2017-02-27T15:29:21Z

Fixes #30.

coveralls · 2017-02-27T16:10:34Z

Coverage remained the same at 91.304% when pulling 0a43437 on cormullion:documenter into a4b9929 on JuliaData:master.

codecov-io · 2017-02-27T17:23:56Z

Codecov Report

Merging #59 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #59   +/-   ##
======================================
  Coverage    91.3%   91.3%           
======================================
  Files           9       9           
  Lines         506     506           
======================================
  Hits          462     462           
  Misses         44      44

Impacted Files	Coverage Δ
src/array.jl	`92.6% <ø> (ø)`	✅

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4b9929...48b960e. Read the comment docs.

nalimilan

Thanks! Could you also add the required code to .travis.yml so that the manual is uploaded? Then I'll add the SSH keys.

nalimilan · 2017-02-27T17:24:52Z

src/array.jl

@@ -715,6 +715,14 @@ function levels! end

 levels!(A::CategoricalArray, newlevels::Vector) = _levels!(A, newlevels)

+# copied from just before droplevels docs...


What do you mean? Anyway, better remove that comment.

nalimilan · 2017-02-27T17:26:09Z

src/array.jl

@@ -715,6 +715,14 @@ function levels! end

 levels!(A::CategoricalArray, newlevels::Vector) = _levels!(A, newlevels)

+# copied from just before droplevels docs...
+"""
+    droplevels!(A::CategoricalArray)


Since this docstrings applies to two different methods, make it apply to function droplevels! end rather than that specific method.

nalimilan · 2017-02-27T18:28:23Z

docs/src/using.md

+
+`categorical(A)` - Construct a categorical array with values from `A`
+
+`compress(A)` - Return a copy of categorical array `A` using the smallest reference type


"smallest possible"?

nalimilan · 2017-02-27T18:30:23Z

docs/src/overview.md

+
+This package provides a replacement for [DataArrays.jl](https://github.com/JuliaStats/DataArrays.jl)'s `PooledDataArray` type.
+
+It offers better performance by getting rid of type instability thanks to the `Nullable` type, which is used to represent missing data. It is also based on a simpler design by only supporting categorical data, which allows offering more specialized features (like ordering of categories). See the [IndirectArrays.jl](https://github.com/JuliaArrays/IndirectArrays.jl) package for a simpler array type storing data with a small number of values.


I would also keep this paragraph and the previous one in README.md so that people can easily know what this is about.

nalimilan · 2017-02-27T18:31:42Z

README.md

@@ -8,283 +8,10 @@ CategoricalArrays.jl
 [![Coveralls](https://coveralls.io/repos/github/JuliaData/CategoricalArrays.jl/badge.svg)](https://coveralls.io/github/JuliaData/CategoricalArrays.jl)
 [![Codecov](https://codecov.io/gh/JuliaData/CategoricalArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaData/CategoricalArrays.jl)

-Tools for working with categorical variables, both with unordered (nominal variables)


I would keep this paragraph so that people can easily know what this is about (even if it's duplicated in the manual).

cormullion · 2017-02-27T18:40:22Z

Will do these edits tomorrow probably. Hope it's helped a bit.

nalimilan · 2017-02-28T09:50:47Z

src/array.jl

@@ -580,13 +580,6 @@ Return levels which appear in `A`, in the same order as [`levels`](@ref)
 """
 function unique end

-"""


Oh, so the docstring was here originally? Then please keep it here, and not duplicate it below. What I was asking for was actually the current state... Why did you move it?

Originally I put the droplevels! docstrings before the droplevels! function, line 719, rather than before droplevels, because it didn't get documented (but I copied rather than moved, so that you could see what I'd done). Then in the edit I removed the original.

OK, sorry, I hadn't spotted the difference between droplevels! and droplevels. That's just a typo: please just add the ! in function droplevels end (the droplevels function isn't supposed to exist and has no methods currently).

cormullion · 2017-02-28T10:10:02Z

Ok, this is as far as I can go—there's the gh-pages branch business for you still to do.

(Note that the logo is just a placeholder until #2 is closed.)

coveralls · 2017-02-28T10:29:54Z

Coverage remained the same at 91.304% when pulling eda7a96 on cormullion:documenter into a4b9929 on JuliaData:master.

coveralls · 2017-02-28T10:29:54Z

Coverage remained the same at 91.304% when pulling eda7a96 on cormullion:documenter into a4b9929 on JuliaData:master.

coveralls · 2017-02-28T10:29:54Z

Coverage remained the same at 91.304% when pulling eda7a96 on cormullion:documenter into a4b9929 on JuliaData:master.

coveralls · 2017-02-28T10:59:38Z

Coverage remained the same at 91.304% when pulling 48b960e on cormullion:documenter into a4b9929 on JuliaData:master.

coveralls · 2017-02-28T10:59:39Z

Coverage remained the same at 91.304% when pulling 48b960e on cormullion:documenter into a4b9929 on JuliaData:master.

nalimilan · 2017-02-28T11:00:50Z

Thanks! That's really appreciated.

nalimilan · 2017-02-28T12:45:38Z

The build succeeded, but it looks like we need Documenter to generate an index.html page? Browsing to https://juliadata.github.io/CategoricalArrays.jl/latest/ failed, but https://juliadata.github.io/CategoricalArrays.jl/latest/using.html works.

cormullion · 2017-02-28T13:21:58Z

I think eg Documenter.jl's home page has a HTML Redirect page.

cormullion · 2017-02-28T13:48:02Z

Or perhaps we should rename overview.md and change the make.jl file accordingly.

nalimilan · 2017-02-28T15:38:52Z

The redirect is a good idea, but the links should work without it. Looks like we indeed need to rename overview.md to index.md. Should probably be added to the Documenter manual.

nalimilan · 2017-03-02T14:53:39Z

OK, the rename fixed the link.

first pass at Documenter docs

0a43437

nalimilan reviewed Feb 27, 2017

View reviewed changes

cormullion added 2 commits February 28, 2017 09:47

edits from comments in #59

f877a49

oops .travis.yml formatting error

eda7a96

nalimilan reviewed Feb 28, 2017

View reviewed changes

changed droplevels to droplevels\!

48b960e

nalimilan merged commit d634683 into JuliaData:master Feb 28, 2017

cormullion deleted the documenter branch March 1, 2017 11:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

first pass at Documenter docs #59

first pass at Documenter docs #59

cormullion commented Feb 27, 2017 •

edited by nalimilan

Loading

coveralls commented Feb 27, 2017 •

edited

Loading

codecov-io commented Feb 27, 2017 •

edited

Loading

nalimilan left a comment

nalimilan Feb 27, 2017

nalimilan Feb 27, 2017

nalimilan Feb 27, 2017

nalimilan Feb 27, 2017

nalimilan Feb 27, 2017

cormullion commented Feb 27, 2017

nalimilan Feb 28, 2017

cormullion Feb 28, 2017

nalimilan Feb 28, 2017

cormullion commented Feb 28, 2017

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017 •

edited

Loading

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017 •

edited

Loading

nalimilan commented Feb 28, 2017

nalimilan commented Feb 28, 2017

cormullion commented Feb 28, 2017

cormullion commented Feb 28, 2017

nalimilan commented Feb 28, 2017

nalimilan commented Mar 2, 2017

		@@ -715,6 +715,14 @@ function levels! end

		levels!(A::CategoricalArray, newlevels::Vector) = _levels!(A, newlevels)

		# copied from just before droplevels docs...


		`categorical(A)` - Construct a categorical array with values from `A`

		`compress(A)` - Return a copy of categorical array `A` using the smallest reference type


		This package provides a replacement for [DataArrays.jl](https://github.com/JuliaStats/DataArrays.jl)'s `PooledDataArray` type.

		It offers better performance by getting rid of type instability thanks to the `Nullable` type, which is used to represent missing data. It is also based on a simpler design by only supporting categorical data, which allows offering more specialized features (like ordering of categories). See the [IndirectArrays.jl](https://github.com/JuliaArrays/IndirectArrays.jl) package for a simpler array type storing data with a small number of values.

first pass at Documenter docs #59

first pass at Documenter docs #59

Conversation

cormullion commented Feb 27, 2017 • edited by nalimilan Loading

coveralls commented Feb 27, 2017 • edited Loading

codecov-io commented Feb 27, 2017 • edited Loading

Codecov Report

nalimilan left a 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

cormullion commented Feb 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cormullion commented Feb 28, 2017

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017 • edited Loading

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017

coveralls commented Feb 28, 2017 • edited Loading

nalimilan commented Feb 28, 2017

nalimilan commented Feb 28, 2017

cormullion commented Feb 28, 2017

cormullion commented Feb 28, 2017

nalimilan commented Feb 28, 2017

nalimilan commented Mar 2, 2017

cormullion commented Feb 27, 2017 •

edited by nalimilan

Loading

coveralls commented Feb 27, 2017 •

edited

Loading

codecov-io commented Feb 27, 2017 •

edited

Loading

coveralls commented Feb 28, 2017 •

edited

Loading

coveralls commented Feb 28, 2017 •

edited

Loading