Smooth out the docs - Githubissues

AspenWeb / pando.py

Filesystem dispatch + Simplates + Python = a nice web framework.

http://aspen.io/

Other

149 stars 38 forks source link

Smooth out the docs #47

Closed chadwhitacre closed 11 years ago

chadwhitacre commented 12 years ago

Docs barely kept up with request and config refactors in 0.15 and 0.16. Collect problems here and preen the docs before 1.0.

chadwhitacre commented 12 years ago

Note that you can set project_root to www_root by passing ''.

chadwhitacre commented 12 years ago

What's the default for project_root? '' or None? aspen --help is ambiguous.

jarpineh commented 12 years ago

Commenting here like the mailing list...

Thrash doc tell you to use aspen.conf and set the changes_kill settings there, but the new way seems to be aspen command line with the --changes_kill=yes parameter

chadwhitacre commented 12 years ago

Nice error messages are linked but not doc'd.

Linked from http://aspen.io/hooks/

chadwhitacre commented 12 years ago

aspen and thrash would ideally get man pages

chadwhitacre commented 12 years ago

Reloading is now more complicated than just thrash.

HUP triggers re-os.execv (but Windows?)
--changes_reload triggers HUP when Python files change (modules and configuration scripts)
--changes_reload triggers non-caching template bases
simplates behave as usual (non-caching ... when? Wait ... what do we do again?)
thrash useful for fatal exits; now features a backoff algorithm with bookends

Maybe it's own page?