List of undocumented exports for 0.2 #2242

kmsquire · 2013-02-09T02:39:03Z

Updated 1 Aug 2013, 9:47am PST

This updated list was produced using a modified version of the julia code provided by @jiahao, now located in JULIA_HOME/doc/DocCheck.jl. A new version can be generated using

cd("$JULIA_HOME/../../doc")
import DocCheck
DocCheck.undocumented_rst()

Note that as of the merging of #3912, JULIA_HOME/doc/UNDOCUMENTED.rst contains a template for all undocumented variables. The list can also be found at http://docs.julialang.org/en/latest/UNDOCUMENTED/.

809/1183 exports have been documented
(Additionally, 1 deprecated functions are still documentated)

The following exports are not documented:

Modules

Types

Ccall types

Exceptions

Global constants and variables

Mathematical constants

catalan

Operators

scalar math

specfun

besselh
polygamma

arrays

linear algebra

sparse

spdiagm

bitarrays

dequeues

prepend!

collections

issubset

strings and text output

random numbers

AbstractRNG
randn!

bigfloat & precision

statistics

hist2d
median!
quantile!

signal processing

conv2
plan_brfft

numerical integration

iteration

object identity and equality

deepcopy_internal

tasks and conditions

time

errors

systemerror

types

syntax

help and reflection

loading source files

RTS internals

gc_bytes
precompile

misc

tty_cols
tty_rows

IP address stuff

I/O and events

multiprocessing

ClusterManager
isready

distributed arrays

localpart

paths and file names

filesystem operations

external processes ## TODO: whittle down these exports.

C interface

Macros

Documented and deprecated functions/exports (please update docs)

addprocs_sge

The text was updated successfully, but these errors were encountered:

pao · 2013-02-09T04:02:20Z

I know I mention this fairly frequently, but please keep in mind that @macros will ping a bunch of people not involved with Julia if we don't quote properly, so try to avoid doing that in issues! I'd like not to annoy the heck out of a bunch of people.

(Also, yes, documentation is great.)

StefanKarpinski · 2013-02-09T07:00:11Z

Yikes. That's a terrifying amount of stuff to document.

timholy · 2013-02-09T12:26:15Z

Maybe we can all do small chunks (I just did one), or put out a plea for help on the user list?

timholy · 2013-02-09T12:27:24Z

And a tip: for filling in the checkboxes, it's a good idea to do it in "Edit" mode, as the browser takes a while to update for each check.

JeffBezanson · 2013-02-09T22:56:40Z

I agree; we should divide this up among a set of volunteers. Then it could be finished quickly.

ViralBShah · 2013-02-10T01:02:59Z

Is there a way to have multiple functions share the same help? This would greatly help.

I have improved help for the linear algebra stuff on vs/linalg2 which I will pull into master, irrespective of the changes to Factorization objects.

mbaz · 2013-02-10T01:26:17Z

I can probably help with a few. Before I start, one question: where to write the docs? For example, I recently had use for isprime() and I can write its documentation. Should it go under math functions, numbers, or integers?

[pao: checked these off, and xref #2249]

timholy · 2013-02-10T12:11:17Z

Batch 2 done.

binarybana · 2013-02-11T05:38:16Z

Edit: Okay, I've got the pull request here for the collections group with some other bonuses. I only missed two: map! and endof, as I thought I'd leave those to someone with bitarray and unicode knowledge.

Unfortunately, this list of undocumented functions is only a lower bound as there are many functions where one set of arguments is documented, but not others. See help(|) and methods(|) for a bad example (though I've included docs for the |(Any,Function) format as I found its usage in the original post intriguing). But we must soldier on nonetheless! :)

timholy · 2013-02-12T09:39:25Z

Thanks, Jason. I've updated the checkboxes.

kmsquire · 2013-02-12T19:48:00Z

Someone might want to look at #2147 and rebase/merge, even though it's labeled WIP.

(Sorry not to contribute more docs myself, I have a Friday deadline to meet.)

…iaLang#2242)

Conflicts: doc/stdlib/base.rst

Add ccall-related function docs to stdlib, for #2242

jiahao · 2013-04-18T21:05:54Z

Just updated the list.

Here is a 15-line Julia script that will do the same if run in the Julia base directory:

havehelp = String[]
for line in split(open(readall, "usr/share/julia/helpdb.jl"), "\n")
   t = split(line, ",")
   if length(t) >= 4 && t[1][1]=='(' && contains(t[3], '"')
       push!(havehelp, replace(t[3],"\"", ""))
   end
end
exports=[strip(x) for x in split(replace(open(readall, "base/exports.jl"),",",""),"\n")]
for line in exports
    if contains(havehelp, line) || search(line, "deprecated")!=0:-1 continue end
    if length(line)>1 && line[1]=='#' && line[2]!= ' ' continue end
    if length(line)>1 && line[1]=='@' line = line[2:end] end
    if length(line)>1 && line[1]!='#' line = string("- [ ] ", line) end
    println(line)
end

kmsquire · 2013-04-18T22:57:09Z

Excellent!

andrioni · 2013-04-23T04:46:09Z

This list counts a bit wrongly some functions, as FFTW.r2r, FFTW.r2r!, FFTW.plan_r2r and FFTW.plan_r2r! all count just as FFTW.

Another thing, what's supposed to be a module documentation? We have Test and Sort documented, and some others are just imported into Base (Pkg, GMP, LinAlg).

ViralBShah · 2013-04-23T05:50:16Z

@kmsquire Could you perhaps rerun your script and update the list of functions that still need to be documented?

Everything that is exported should be documented, whether it is Base, or in a submodule.

ViralBShah · 2013-08-01T05:38:28Z

@kmsquire Would it be possible to update this list in preparation for the 0.2 release? I updated the title to reflect that this is to track documentation of functions for the 0.2 release.

kmsquire · 2013-08-01T16:57:53Z

Done. I also updated the text to indicate how anyone with write access can update this issue in the future.

kmsquire · 2013-08-01T22:47:43Z

I generated a basic template for all undocumented functions in #3912. Not quite in-place documenting, but it should make it easier for someone to fill in and copy to the right place.

vtjnash · 2013-08-06T03:39:55Z

I'm not sure where to ask this, but since I noticed it while documenting: Can I deprecate the export of the solve function? It appears to be an implementation detail of the \ operator for several special-case types and not a general purpose interface.

vtjnash · 2013-08-06T04:03:10Z

Similarly symmetrize! seems be be an odd function to export, but not it's pair symmetrize_conj!. Should both be removed or both be exported?

vtjnash · 2013-08-06T04:41:41Z

moving discussion of deprecating exports to #3950

JeffBezanson · 2013-08-30T20:29:00Z

We are getting close here. Only the following functions are left: besselh, gradient, solve, symmetrize!, xdump, mmap_grow, mmap_stream_settings, get!, fld1

I can only hope that people who know what these functions do will either document them or un-export them.

johnmyleswhite · 2013-08-30T20:30:18Z

I can document fld1, but I suspect @StefanKarpinski might prefer that we not export it at all.

andrioni · 2013-08-30T20:47:55Z

besselh is basically a way to choose between hankelh1 and hankelh2 (the pair of Bessel functions of third kind/Hankel functions):

besselh(n, z) = hankelh1(n, z),
besselh(n, k<=1, z) = hankelh1(n, z),
besselh(n, k>=2, z) = hankelh2(n, z).

timholy · 2013-08-31T19:42:40Z

I don't think we need to export those two mmap functions. If no one explains in the next day or so, I'll un-export them.

binarybana mentioned this issue Feb 11, 2013

Collections docs #2261

Merged

dirk added a commit to dirk/julia that referenced this issue Feb 12, 2013

Add more documentation for string functions (see JuliaLang#2147 & Jul…

bca6844

…iaLang#2242)

JeffBezanson pushed a commit that referenced this issue Feb 13, 2013

Add more documentation for string functions (see #2147 & #2242)

19ec33e

Conflicts: doc/stdlib/base.rst

dirk mentioned this issue Feb 15, 2013

WIP: documentation improvements #2147

Closed

ihnorton mentioned this issue Feb 15, 2013

update ccall documentation #2145

Closed

StefanKarpinski added a commit that referenced this issue Feb 16, 2013

Merge pull request #2320 from ihnorton/master

35e0a0f

Add ccall-related function docs to stdlib, for #2242

kmsquire mentioned this issue May 15, 2013

RFC: Added doc/DocCheck.jl: functions for checking documentation status #3120

Merged

This was referenced Aug 1, 2013

Docs: include top-level module documentation in helpdb.jl #3911

Closed

Added doc/UNDOCUMENTED.rst, functions for generating #3912

Merged

staticfloat mentioned this issue Aug 1, 2013

Add documentation for conv2()/plan_brfft() #3913

Merged

JeffBezanson closed this as completed in 90027d6 Sep 3, 2013

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

List of undocumented exports for 0.2 #2242

List of undocumented exports for 0.2 #2242

kmsquire commented Feb 9, 2013

pao commented Feb 9, 2013

StefanKarpinski commented Feb 9, 2013

timholy commented Feb 9, 2013

timholy commented Feb 9, 2013

JeffBezanson commented Feb 9, 2013

ViralBShah commented Feb 10, 2013

mbaz commented Feb 10, 2013

timholy commented Feb 10, 2013

binarybana commented Feb 11, 2013

timholy commented Feb 12, 2013

kmsquire commented Feb 12, 2013

jiahao commented Apr 18, 2013

kmsquire commented Apr 18, 2013

andrioni commented Apr 23, 2013

ViralBShah commented Apr 23, 2013

ViralBShah commented Aug 1, 2013

kmsquire commented Aug 1, 2013

kmsquire commented Aug 1, 2013

vtjnash commented Aug 6, 2013

vtjnash commented Aug 6, 2013

vtjnash commented Aug 6, 2013

JeffBezanson commented Aug 30, 2013

johnmyleswhite commented Aug 30, 2013

andrioni commented Aug 30, 2013

timholy commented Aug 31, 2013

List of undocumented exports for 0.2 #2242

List of undocumented exports for 0.2 #2242

Comments

kmsquire commented Feb 9, 2013

Modules

Types

Ccall types

Exceptions

Global constants and variables

Mathematical constants

Operators

scalar math

specfun

arrays

linear algebra

sparse

bitarrays

dequeues

collections

strings and text output

random numbers

bigfloat & precision

statistics

signal processing

numerical integration

iteration

object identity and equality

tasks and conditions

time

errors

types

syntax

help and reflection

loading source files

RTS internals

misc

IP address stuff

I/O and events

multiprocessing

distributed arrays

paths and file names

filesystem operations

external processes ## TODO: whittle down these exports.

C interface

Macros

pao commented Feb 9, 2013

StefanKarpinski commented Feb 9, 2013

timholy commented Feb 9, 2013

timholy commented Feb 9, 2013

JeffBezanson commented Feb 9, 2013

ViralBShah commented Feb 10, 2013

mbaz commented Feb 10, 2013

timholy commented Feb 10, 2013

binarybana commented Feb 11, 2013

timholy commented Feb 12, 2013

kmsquire commented Feb 12, 2013

jiahao commented Apr 18, 2013

kmsquire commented Apr 18, 2013

andrioni commented Apr 23, 2013

ViralBShah commented Apr 23, 2013

ViralBShah commented Aug 1, 2013

kmsquire commented Aug 1, 2013

kmsquire commented Aug 1, 2013

vtjnash commented Aug 6, 2013

vtjnash commented Aug 6, 2013

vtjnash commented Aug 6, 2013

JeffBezanson commented Aug 30, 2013

johnmyleswhite commented Aug 30, 2013

andrioni commented Aug 30, 2013

timholy commented Aug 31, 2013