Re: [matplotlib-devel] annotation with fancy arrow

On Thu, Oct 30, 2008 at 12:32 AM, Jae-Joon Lee <lee...@gm...> wrote:
> John and others,
>
> I submitted a patch of the fancy arrow I mentioned a while ago.
>
> http://sourceforge.net/tracker2/?func=detail&aid=2209021&group_id=80706&atid=560722

Hi Jae Joon -- sorry for not responding.  I had completely missed
this.  Reminding us on the mailing list is definitely a good idea
because I tend to fall behind quite often.

The patch and new example look great.  My only requests for changes
(or for next time) are stylistic:

  - when making a significant contribution like this, please add a
change to the CHANGELOG, since that is what many people use to see
what's new and what we use to make the release notes.  I've done this
already for this one.

  - try and document every method using the rest documentation
conventions.  See
http://matplotlib.sourceforge.net/devel/documenting_mpl.html.  Since
we have been working hard on the website and API docs, the one thing
I'd like to ask of you is to make sure all the docstrings are updated
including a bit of module level documentation in bezier -- then I will
add bezier to the API docs


  - for triple quoted docstrings, I would like to stick to the format::

    def myfunc(args):
        """"
        this is my docstring
        """"

   rather than


    def myfunc(args):
        """"this is my docstring
        """"

  - I renamed bezier_util to bezier (PEP8 style guide advises to avoid
underscores and make module names as short as is reasonable), and we
should import it with the full name "from matplotlib.bezier import
..." rather than "from bezier import ..."

  - is using a string for connectionstyle the best choice?  Ie, instead of::

      connectionstyle="angle,angleA=0,angleB=90,rad=10"

    would we rather have something like::

      connectionstyle=connectionstyle.angle(angleA=0,angleB=90,rad=10)

    The latter looks more pythonthic and extensible, because if we document the
    connectionstyle API users can provide their own.

These are of course mostly minor stylistic nits, but I want the code
to be as uniform as possible.

I've committed this to svn r6353, and updated the website, so you can
see your examples in the gallery and examples pages:

  http://matplotlib.sourceforge.net/gallery.html
  http://matplotlib.sourceforge.net/gallery.html

Very nice contribution!
JDH