Changes between Version 1 and Version 2 of DocsTasklist

Show
Ignore:
Timestamp:
11/21/09 11:52:46 (5 years ago)
Author:
allison
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DocsTasklist

    v1 v2  
    1 Find all examples of PIR embedded in POD documentation anywhere in the repository, and wrap them in PIR target blocks like this: 
     1 * All top-level docs/* files should be user-focused. Put internals and developer documentation in docs/internals/... (users shouldn't have to dig to find help getting started, experienced developers can easily handle an extra directory level). 
     2 * Adjust the 'make html' generators Parrot::Docs::* to match the new paths. 
     3 
     4 * Find all examples of PIR embedded in Pod documentation anywhere in the repository, and wrap them in PIR target blocks like this: 
    25 
    36 
     
    1316}}} 
    1417 
    15 For bonus points, run {{{t/examples/pod.t}}} after you do this and fix any errors this finds in the sample PIR. 
     18For now, only do this with PIR examples that contain complete subs and are expected to work. Partial examples can be wrapped with PIR_FRAGMENT instead. Examples that aren't expected to work can be wrapped in PIR_INVALID or PIR_FRAGMENT_INVALID, and examples that should work but currently don't can be wrapped in PIR_TODO or PIR_FRAGMENT_TODO. 
    1619 
    17 For now, only do this with PIR examples that contain complete subs and are expected to work. 
     20* For bonus points, run {{{t/examples/pod.t}}} after you do this and fix any errors this finds in the sample PIR. 
     21 
     22