[svn:parrot-pdd] r17921 - trunk/docs/pdds

[paultc...@cvs.perl.org]

Author: paultcochrane
Date: Sun Apr 1 00:58:42 2007
New Revision: 17921

Modified:
trunk/docs/pdds/pdd07_codingstd.pod

Log:
[docs] Added a note about Perl source code with __END__ or __DATA__ blocks
not requiring an emacs/vim coda.

Modified: trunk/docs/pdds/pdd07_codingstd.pod
==============================================================================
--- trunk/docs/pdds/pdd07_codingstd.pod (original)
+++ trunk/docs/pdds/pdd07_codingstd.pod Sun Apr 1 00:58:42 2007
@@ -322,6 +322,10 @@
# End:
# vim: expandtab shiftwidth=4:

+B<Exception>: Files with C<__END__> or C<__DATA__> blocks do not require the
+coda. This is at least until there is some consensus as to how solve the
+issue of using editor hints in files with such blocks.
+
=item *

PIR source files should end with this coda:

[Sartak]

On 4/1/07, paultc...@cvs.perl.org <paultc...@cvs.perl.org> wrote:
> Author: paultcochrane
> Date: Sun Apr 1 00:58:42 2007
> New Revision: 17921
>
> Modified:
> trunk/docs/pdds/pdd07_codingstd.pod
>
> Log:
> [docs] Added a note about Perl source code with __END__ or __DATA__ blocks
> not requiring an emacs/vim coda.

I don't know about emacs, but vim also searches the top (ten?) lines
for a coda. So maybe we could put it at/near the top iff there's an
__END__ or __DATA__ block.

Shawn M Moore

Paul: Sorry for sending this to you twice :)

[Paul Cochrane]

On 02/04/07, Sartak <sar...@gmail.com> wrote:
> On 4/1/07, paultc...@cvs.perl.org <paultc...@cvs.perl.org> wrote:
> > Author: paultcochrane
> > Date: Sun Apr 1 00:58:42 2007
> > New Revision: 17921
> >
> > Modified:
> > trunk/docs/pdds/pdd07_codingstd.pod
> >
> > Log:
> > [docs] Added a note about Perl source code with __END__ or __DATA__ blocks
> > not requiring an emacs/vim coda.
>
> I don't know about emacs, but vim also searches the top (ten?) lines
> for a coda. So maybe we could put it at/near the top iff there's an
> __END__ or __DATA__ block.

Thanks for the comment! Unfortunately, we've already been down that
road, and it was decided that having some files with the coda at the
end and some at the top was not a good solution (it would certainly
clutter things at the top of the file). Also, I believe vim only
searches the top 5 lines, so we would also have to change the way the
coda looks for top-of-file version wrt the bottom-of-file version.
Some elegant, general way of setting editor hints in files would be
really nice, but we've not found the answer to that yet ... :-/

Paul