Phoenix - FloatCanvas

[Werner]

Hi,

I was searching for valid values for FillStyle etc and see that the doc
could be improved to show this information in e.g. DrawObject.

My question is about the question "Is this still necessary?" in that
code section. Are there plans to move these dicts to something else or
is it worth my while to update the doc for them into something Sphinx
can deal with?

Werner

[Chris Barker - NOAA Federal]

On Sat, May 4, 2013 at 3:51 AM, Werner <werner...@sfr.fr> wrote:

I was searching for valid values for FillStyle etc and see that the doc could be improved to show this information in e.g. DrawObject.

My question is about the question "Is this still necessary?" in that code section.  Are there plans to move these dicts to something else or is it worth my while to update the doc for them into something Sphinx can deal with?

1st of all -- thanks for working on getting the docs sphinx-compatible -- that'll be great! You may notice some odd markup in there in a few places -- at one point, someone made the docstrings compatible with Doxygen -- before Sphinx existed.

As to your questions -- there are two issues:

1) I originally built a cache system, that keeps dicts of all the pens and brushes that had been used so far (and a few to start out). I suspect this is no longer required -- I think wx does a similar cache under the hood, and to be honest, I never really profiled properly -- it may have never been worthwhile. So, if you're feeling up to it, I say rip out the cache.

2) The API issue -- I wrote the API to be more natural, from my point of view:

SomeObject(FillColor="red",

                    LineColor="blue",

                    LIneWidth="3",

                    ...

                   )

The idea was that the user didn't need to know or care about Pens and Brushes. I'm ambivalent about whether that was a good idea, but I think I still kind of like it, and it would be a significant change in the API to remove it so probably a good idea to keep that API.

So yes, we need a way to get the allowable options for FillStyle etc. in the Sphinx docs.

Thanks again,

-Chris

--

Christopher Barker, Ph.D.
Oceanographer

Emergency Response Division
NOAA/NOS/OR&R            (206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115       (206) 526-6317   main reception

Chris....@noaa.gov