Le vendredi 12 février 2016 à 04:16 -0800, J Luis a écrit : > One main 'dislike' I find in the documentation is that, contrary to > Matlab and R examples that have one page for each function, in julia > we have lots of functions per page with short and often cryptic > descriptions. Example > > std(v[, region]) > Compute the sample standard deviation of a vector or array v, > optionally along dimensions in region. > > To have longer and, VERY IMPORTANT, usage examples one need a per > function page manual. It's not that common for several Julia functions to be documented on the same page. Actually, it's probably less common than in R (have a look at ?grep or ?read.table). But indeed the docs could be expanded in some cases. If you make pull requests adding examples (more precisely doctests that are run and checked when building Julia), I'm sure they will be welcome.
Regards > sexta-feira, 12 de Fevereiro de 2016 às 11:10:54 UTC, Milan Bouchet- > Valat escreveu: > > Le vendredi 12 février 2016 à 09:51 +0100, Michele Zaffalon a > > écrit : > > > But the original point is still valid: using the search box in > > the > > > official documentation page http://docs.julialang.org/en/release- > > 0.4, > > > searching for "standard deviation" does not bring up any useful > > hit, > > > despite the fact that Base.std is fairly well documented and > > contains > > > the words standard deviation. > > > Is there a reason why it should work at the REPL but not in the > > > webpage? > > Searching for "deviation" works, so it's quite mysterious that > > "standard deviation" doesn't... Looks like a bug in the Sphinx > > search > > engine. > > > > Google's behavior is really weird too. Even a query like "standard > > deviation julia site:docs.julialang.org" gives the manual page home > > for > > the standard library first (even if it doesn't contain > > "deviation"), as > > well as pages mentioning "standard error". Maybe some pages are > > not > > indexed at all? Could something be tweaked in the Sphinx > > configuration? > > > > > > Regards > > > > > > > > On Fri, Feb 12, 2016 at 9:25 AM, Mauro <[email protected]> > > wrote: > > > > Also at the Julia REPL: > > > > > > > > julia> apropos("standard deviation") > > > > randn! > > > > stdm > > > > std > > > > randn > > > > > > > > help?> std > > > > search: std stdm STDIN STDOUT STDERR setdiff setdiff! > > hist2d > > > > hist2d! stride strides StridedArray StridedVector > > StridedMatrix > > > > StridedVecOrMat redirect_stdin > > > > > > > > std(v[, region]) > > > > > > > > Compute the sample standard deviation of a vector or > > array v, > > > > optionally along dimensions in region. The algorithm returns > > an > > > > estimator of the generative > > > > distribution's standard deviation under the assumption > > that > > > > each entry of v is an IID drawn from that generative > > distribution. > > > > This computation is equivalent to > > > > calculating sqrt(sum((v - mean(v)).^2) / (length(v) - > > 1)). > > > > Note: Julia does not ignore NaN values in the computation. For > > > > applications requiring the handling of > > > > missing data, the DataArray package is recommended. > > > > > > > > Having said this, documentation always needs improvements and > > is > > > > certainly not on Matlab's level of completeness. Please > > contribute > > > > where you find it lacking. See > > > > https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md# > > impr > > > > oving-documentation > > > > > > > > > > > > On Fri, 2016-02-12 at 09:18, NotSoRecentConvert <[email protected] > > om> > > > > wrote: > > > > > You can even download the entire thing as a PDF, HTML, or > > EPUB if > > > > you want > > > > > to highlight, annotate, or bookmark your most searched > > functions. > > > > Look in > > > > > the lower right of the page for "v: latest" and click it for > > more > > > > options. > > > > > > > > > > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah > > Tomak > > > > wrote: > > > > >> > > > > >> There is this one > > > > >> > > > > >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.s > > td > > > > >> > > > > >> Instead of google, I use this manual for search. > > > > >> > > > > >> > > > >
