# New Ticket Created by  [EMAIL PROTECTED] 
# Please include the string:  [perl #23411]
# in the subject line of all future correspondence about this issue. 
# <URL: http://rt.perl.org/rt2/Ticket/Display.html?id=23411 >


This patch creates ABSTRACT and OVERVIEW sections in docs/strings.pod.
The text is a zero-effort placeholder draft.
Its purpose is to capture the intent of Parrot Strings, which has
recently been a topic of discussion on the mailinglist.
It may or may not reflect the current code.
Shamelessly plagiarized from Larry, via Tim.

Specifically:

  =head1 ABSTRACT

  Parrot Strings are chunked international strings.

  =head1 OVERVIEW

  For various reasons, some of which relate to the sequence-of-integer
  abstraction, and some of which relate to "infinite" strings and arrays,
  Parrot Strings are represented by a list of chunks, where each chunk
  is a sequence of integers of the same size or representation,
  but different chunks can have different integer sizes or representations.
  The Parrot String API hides this from any module that wishes to work
  at the abstract string level.  In particular, it must hide this from
  the regex engine, which works on pure sequences in the abstract.

  So Parrot Strings are a wizzy internationalized equivalent of the
  old standard C library's string.h functions.



-- attachment  1 ------------------------------------------------------
url: http://rt.perl.org/rt2/attach/63067/46437/ba7520/string_pod_abstract.patch

--- docs/strings.pod    Mon Jul 28 03:00:03 2003
+++ docs/strings.pod.wabstract  Tue Aug 19 11:06:57 2003
@@ -2,6 +2,24 @@
 
 Parrot Strings
 
+=head1 ABSTRACT
+
+Parrot Strings are chunked international strings.
+
+=head1 OVERVIEW
+
+For various reasons, some of which relate to the sequence-of-integer
+abstraction, and some of which relate to "infinite" strings and arrays,
+Parrot Strings are represented by a list of chunks, where each chunk
+is a sequence of integers of the same size or representation,
+but different chunks can have different integer sizes or representations.
+The Parrot String API hides this from any module that wishes to work
+at the abstract string level.  In particular, it must hide this from
+the regex engine, which works on pure sequences in the abstract.
+
+So Parrot Strings are a wizzy internationalized equivalent of the
+old standard C library's string.h functions.
+
 =head1 The Parrot String API
 
 This document describes how Parrot abstracts the programmer's interface

Reply via email to