[yt-dev] Issue #661: Add 'gotchas' subsections to the docs (yt_analysis/yt)

[Nathan Goldbaum]

New issue 661: Add 'gotchas' subsections to the docs
https://bitbucket.org/yt_analysis/yt/issue/661/add-gotchas-subsections-to-the-docs

Nathan Goldbaum:

Where appropriate, we should add subsections to existing doc pages with listings of common 'gotchas'. See for example the sympy docs: http://docs.sympy.org/dev/gotchas.html

One example: when someone tries to plot a field that by default has logarithmic colorbar scaling, but with less than an order of magnitude in dynamic range, there will either be one or zero tick marks, making it very difficult to judge the scale.  The solution is to turn off field logging but that's not obvious to a new user, so it should be in the docs.  I suspect there are many other places in yt where similar gotchas exist.