Flux.jl/src/data
bors[bot] 7a32a703f0
Merge #853
853: Improve docs r=CarloLucibello a=janEbert

If you disagree with any of the changes, please tell me what to reverse or fix.
I am unsure about the docstrings I added to `src/utils.jl` for `unsqueeze` and
the `[un]stack` functions so please give those a more detailed look.

Update Documenter.jl version for new features, fix deprecation warnings in
`docs/make.jl` and import Flux for all doctests.
Add missing docstrings to `src/utils.jl`, `src/layers/stateless.jl` and `src/data/`; add
these and other missing functions to Markdown docs.

Improve docstrings by...
   - fixing typos,
   - removing trailing or double whitespaces,
   - using `jldoctest` blocks where applicable,
   - fixing, updating or correctly setting up existing doctests,
   - improving consistency (for example, always use "# Examples" instead
     of other variants),
   - removing empty lines between docstrings and functions,
   - instead of mentioning keywords, put them into the docstring,
   - adding some missing but useful keywords,
   - adding references (`@ref`),
   - using LaTeX math where applicable, and
   - linking papers.

Debatable stuff that is untouched:
   - BE/AE s/z irregularities (e.g. "normalise" versus "normalize") since
     most papers use the AE version while the Flux source code was
     written with BE spelling.
   - Names of normalization functions are capitalized
     ("Batch Normalization" instead of "batch normalization").
   - Default values in argument lists have spaces around the equals sign (`arg = x` instead of `arg=x`).

Co-authored-by: janEbert <janpublicebert@posteo.net>
2020-04-06 13:47:42 +00:00
..
cmudict.jl General minuscule improvements 2020-04-04 19:43:28 +02:00
Data.jl fix rebase 2020-02-29 18:55:49 +01:00
dataloader.jl fix typos 2020-03-22 09:41:29 +08:00
fashion-mnist.jl Improve docstrings 2020-04-04 18:16:46 +02:00
housing.jl fix housing download 2020-04-06 11:08:20 +02:00
iris.jl Improve docstrings 2020-04-04 18:16:46 +02:00
mnist.jl Improve docstrings 2020-04-04 18:16:46 +02:00
sentiment.jl Add missing docstrings to src/data. 2020-04-04 18:16:46 +02:00
tree.jl reorganise batches 2018-02-13 16:05:07 +00:00