FlyRanch / figurefirst

A layout-first approach to figure making
http://flyranch.github.io/figurefirst
MIT License
80 stars 15 forks source link

Document layer-hiding behaviour and fix FigureLayout docstring #49

Closed clbarnes closed 5 years ago

clbarnes commented 5 years ago

See #48: it was an "I don't understand figurefirst" issue rather than a bug. This PR:

  1. Adds some documentation to stop others getting stuck like me!
  2. Fixes the "Basic usage" example which didn't actually work
  3. Formats the FigureLayout docstring nicely
  4. Replaces the default hide_layers list with a tuple, because bad things can happen with mutable default arguments.