search

aigeano / pympler

Automatically exported from code.google.com/p/pympler
Apache License 2.0
0 stars 0 forks source link

Unified documentation #26

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Up to now, we have three separate documentations for each of the three main
modules. It would be nice to merge them in a unified structure.
Furthermore, we should give meaningful names in the TOC (asizeof,muppy and
classtracker won't mean anything to most people). Here is a quick draft of
how this could look like (the layout is derived from muppy's docs):

* Sizing individual objects - Low-level interface (Asizeof)
* Detecting leaks/On-line analysis (Muppy) [couldn't think of a good name]
* Tracking class instances (ClassTracker)
* Library Documentation (for each module)
* Tutorials

A first step would be to split or replicate the library docs for asizeof
and lift the muppy documentation one level.

Original issue reported on code.google.com by lhae...@gmail.com on 7 Feb 2009 at 10:10

GoogleCodeExporter commented 9 years ago 
Changes made in r311, r312, 313, r314, r315.

Original comment by lhae...@gmail.com on 13 Jun 2011 at 4:03