description: unknown (?!?!?)

In many places in the mpl docs there are tables of supported “kwarg properties” containing at least one (usually many) entries where the description given for the property is simply “unknown”. What’s up with that??? How can the description of a property be unknown???

Any clarification for what this “unknown” notation means would be appreciated.

Thanks,

G

Most likely, it means that the person who wrote that portion of the documentation was not familiar enough with the code to know for sure exactly what that particular property does. We should aim to find and fix all of these for the next release.

Ben Root

···

On Thu, Feb 3, 2011 at 9:19 AM, Gf B <gbspambucket@…120…287…> wrote:

In many places in the mpl docs there are tables of supported “kwarg properties” containing at least one (usually many) entries where the description given for the property is simply “unknown”. What’s up with that??? How can the description of a property be unknown???

Any clarification for what this “unknown” notation means would be appreciated.

Thanks,

G

Ben,

I think that it is coming from the document autogeneration mechanism related to the automatic handling of "set_*()" methods. If they lack an "ACCEPTS:" block, then "unknown" is substituted. An example is the obscure "agg_filter" property that everything inherits from artist.

Possibly the solution is to change the autogeneration to ignore such methods when gathering "properties".

Eric

···

On 02/08/2011 06:42 AM, Benjamin Root wrote:

On Thu, Feb 3, 2011 at 9:19 AM, Gf B <gbspambucket@…287… > <mailto:gbspambucket@…287…>> wrote:

    In many places in the mpl docs there are tables of supported "kwarg
    properties" containing at least one (usually many) entries where the
    description given for the property is simply "unknown". What's up
    with that??? How can the description of a property be unknown???

    Any clarification for what this "unknown" notation means would be
    appreciated.

    Thanks,

    G

Most likely, it means that the person who wrote that portion of the
documentation was not familiar enough with the code to know for sure
exactly what that particular property does. We should aim to find and
fix all of these for the next release.

Ben Root