Missing Documentation

[dcjones]

Stuff that isn't documented that needs to be:

Guides:

• Guide.xlabel
• Guide.ylabel
• Guide.xticks
• Guide.yticks
• Guide.title
• Guide.colorkey

Scales:

• Continuous scales. (Scale.x_continuous, Scale.y_continuous, etc) Predefined transforms (Scale.x_log10, etc). Defining new transforms.
• Discrete scales. (Scale.x_discrete, Scale.y_discrete, etc)
• Discrete color scales.
• Continuous color scales.

Statistics:

• Stat.histogram
• Stat.density
• Stat.histogram2d
• Stat.xticks/Stat.yticks
• Stat.boxplot
• Stat.smooth
• Stat.hexbin
• Stat.step

Miscellaneous

• spy
• Plotting non-number continuous types (e.g. time series). Interface required for a type to be plotable.
• hstack/vstack

[dchudz]

Helping with the documentation seems like a small way that maybe I could contribute, but first I'd need to understand what you're doing to generate the documentation. Can you help me with that?

When I run this, the markdown compiles to HTML, but I don't think it ran any of the Julia code in any of the blocks:

$~/.julia/Judo/bin/judo ~/github/Gadfly.jl/  --package

It generates some HTML files in docs/html, but there's a lot less stuff in that HTML than in your HTML documentation. I think it's missing everything that results from running the blocks. See here. It's the same whether I use ---package or just run judo on one file. (Also the code blocks that are supposed to be hidden show up anyway. I imagine that's due to the same root cause.)

Presumably I'm missing something about what I should do. Can you tell me what I'm missing? Sorry if it's obvious.

As an aside, running Jekyll to serve your documentation locally works fine for me, and it all still looks fine when I use the HTML that I generated from markdown with judo... except for the missing plot and other results from Julia.

[dcjones]

I'd certainly welcome help with documentation. Sorry Judo is so crusty, I'm not sure what's going on here.

Can you tell me you're pandoc --version?

[dchudz]

$pandoc --version
pandoc 1.12.3
Compiled with texmath 0.6.6, highlighting-kate 0.5.6.
Syntax highlighting is supported for the following languages:
actionscript, ada, apache, asn1, asp, awk, bash, bibtex, boo, c, changelog,
clojure, cmake, coffee, coldfusion, commonlisp, cpp, cs, css, curry, d,
diff, djangotemplate, doxygen, doxygenlua, dtd, eiffel, email, erlang,
fortran, fsharp, gnuassembler, go, haskell, haxe, html, ini, java, javadoc,
javascript, json, jsp, julia, latex, lex, literatecurry, literatehaskell,
lua, makefile, mandoc, markdown, matlab, maxima, metafont, mips, modelines,
modula2, modula3, monobasic, nasm, noweb, objectivec, objectivecpp, ocaml,
octave, pascal, perl, php, pike, postscript, prolog, python, r,
relaxngcompact, restructuredtext, rhtml, roff, ruby, rust, scala, scheme,
sci, sed, sgml, sql, sqlmysql, sqlpostgresql, tcl, texinfo, verilog, vhdl,
xml, xorg, xslt, xul, yacc, yaml
Default user data directory: /Users/david/.pandoc
Copyright (C) 2006-2013 John MacFarlane
Web: http://johnmacfarlane.net/pandoc
This is free software; see the source for copying conditions. There is no
warranty, not even for merchantability or fitness for a particular purpose.

[dchudz]

I'm on Julia 0.2.0 (b/c some stuff in some other packages wasn't working for me in 0.3.0.) Versions of all my packages:

Required packages:

• ArgParse 0.2.8
• Cairo 0.2.12
• DataArrays 0.0.2
• DataFrames 0.4.2
• Gadfly 0.2.3+ master
• IJulia 0.1.4
• MCMC 0.0.2 20b7d263 (dirty)
• Mustache 0.0.2
• Optim 0.2.0
• RDatasets 0.0.3
• Stats 0.1.0
• Vega 0.0.0+ 19be96fb
• YAML 0.1.7
• ZMQ 0.1.8
  Additional packages:
• BinDeps 0.2.12
• Blocks 0.0.2
• Calculus 0.1.3
• Codecs 0.1.0
• Color 0.2.8
• Compose 0.1.25
• Datetime 0.1.2
• Distance 0.2.6
• Distributions 0.3.0
• DualNumbers 0.0.1
• GZip 0.2.10
• Hexagons 0.0.1
• Homebrew 0.0.4
• Iterators 0.1.2
• JSON 0.3.3
• Judo 0.0.0- master (unregistered)
• LazySequences 0.1.0
• Loess 0.0.2
• Nettle 0.1.3
• NumericExtensions 0.3.6
• Options 0.2.2
• REPLCompletions 0.0.0
• SortingAlgorithms 0.0.1
• StatsBase 0.2.10
• TextWrap 0.1.2
• URIParser 0.0.1

[dchudz]

No problem about Judo. I'll be really happy if I can get it working. Besides helping out with your documentation, Judo is exactly the workflow I want for lots of things, and I haven't found it elsewhere in the Julia ecosystem.

Is there any other logging it would be useful to send? I really appreciate any time you have to help me with this.

[dcjones]

I hadn't updated pandoc in quite a while. In the mean time they completely changed their json serialization. I just pushed a commit to Judo which I think should fix it.

[dchudz]

Works beautifully now, thanks!

I can't quite create all the documentation yet -- I think that's because we need to replace data() with dataset(). It didn't look like there was an issue yet, so I opened one: #193

[darwindarak]

I'm trying to add some more documentation, but it looks like the Gadfly.prepare_display() line in all the existing documentation is preventing Judo from compiling them. Would it be ok if I go ahead and remove that line from all the files or is it needed for something?

[dcjones]

That would be great. It's no longer needed, it was used to make sure d3.js, but now everything is embedded in the SVG.

[gestay]

A couple of features that I didn't found in the docs:

• Fixing aspect ratio: Coord.cartesian(fixed=true)
• Reversed domains: plot(sin,1,0)
• Default colors (Find out what the default Gadfly color values are #602)