Quick Reference from module doc strings.

[Ron Adam]

Michele Simionato wrote:
> Ron Adam:
> 
>>Thats part of what I'm trying to resolve, the doc strings a lot of
> 
> time
> 
>>isn't enough by itself or is missing. So I'm trying to build up a
>>complete enough record so if there is no doc string, at least some
> 
> sense
> 
>>of what it is can be figured out without a lot browsing or looking at
>>the source code.
> 
> 
> I have a command line option so I can decide if I want to display only
> the
> documented objects or every object, including the ones without
> docstring.
> I could add an option to tell "minidoc" to interpret docstrings are
> plain
> text, not restructured text; however I don't want to do that (part of
> the reason for "minidoc" is to force me to write good reST docstrings
> in my own modules).

If it works, don't fix it.  ;-)


>>Then to enable different searches by subject and keywords on these
>>instead of by package or module.
> 
> 
> Well,  my browser has a CTRL-F functionality ;)

I recently switched over to using the GVIMs Cream version as an editor, 
So it should be possible to map a function key to grab the import 
statements from the currently edited document, feed the imported module 
names to quickref and capture the output in a window for searching in 
the same way.

It will be fun to play around with once I get back from a week long trip 
starting Thursday.


>>in case it was an over site.
>  
> Yes, I am aware of it, it was on purpose ;)

I was pretty sure it was.


>>Ps... I like your physics link page. :)
> 
> That page is old, I am no more in physics, but I still have that
> account for free
> and I am lazy, so I am keeping it ;)
> 
>                                 Michele Simionato

I'm not in physics in *any* way, but I have a few pet theories (more 
like opinions really).  So I like to check what's going on and see if 
anyone or anything proves or disproves them.  ;-)