asmeurer at gmail.com
Fri Jul 5 19:58:26 EDT 2013
On Fri, Jul 5, 2013 at 6:43 PM, Brian Granger <ellisonbg at gmail.com> wrote:
> Today, I have been working a lot on the dual mode editor stuff for the
> notebook. Obviously, this means spending lots of time in the
> "docstring" is completely unworkable from a development standpoint:
> * Managing comments in multiline /* */ style comments is horrific
> * The visual clutter of the docstrings makes it very difficult to make
> your way around the code
> * It is painful enough that these docstrings easily fall out of sync
Maybe this isn't the answer you are looking for, but can't the first two
points be solved by a good text editor. Emacs is smart enough to wrap
comments using a combination of auto-fill-mode and M-q. For the second
point, you just need a good code-folding tool.
to have some rough edges.
I do agree that the @param nonsense gets old pretty fast.
> to myself "I don't like this, but I will get used to it, just like I
> did with Python docstrings." Unfortunately, the exact opposite has
> happened - my frustration has grown. In the spirit of GitHub, we need
> to change this in order to "optimize for developer happiness."
> Here is what I propose: I don't care one bit that we can generate
> going to use our JS code, API docs won't go very far - they will need
> to look at the code eventually. Let's come up with a standard that is
> easier to write and maintain for developers...any ideas?
> Brian E. Granger
> Cal Poly State University, San Luis Obispo
> bgranger at calpoly.edu and ellisonbg at gmail.com
> IPython-dev mailing list
> IPython-dev at scipy.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the IPython-dev