[gentoo-pms] EAPI 3 branch could use some reviewing

[gentoo-pms] EAPI 3 branch could use some reviewing

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 634 bytes --]

I think I've removed all the TODO items and included everything that's
on the "possible" list for EAPI 3 now. I'd appreciate it if people
could give this a review before I send it to -dev@ and the Council.

    https://github.com/ciaranm/pms/tree/eapi-3

f6595db..32525af is the introduction for EAPI 3.

33e5bcd..e6b9956 is potential EAPI 3 features.

725d5ae..1c311de is formatting for the new margin labels thing. This'll
hopefully get modified before we go live with it.

d96c259..b1b3feb are various misc tweaks that aren't EAPI 3 related,
but that aren't worth sticking in master for now.

-- 
Ciaran McCreesh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [gentoo-pms] EAPI 3 branch could use some reviewing

[Christian Faulhammer]

[-- Attachment #1: Type: text/plain, Size: 1532 bytes --]

Hi,

Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:

> I think I've removed all the TODO items and included everything that's
> on the "possible" list for EAPI 3 now. I'd appreciate it if people
> could give this a review before I send it to -dev@ and the Council.

 As far as I can see the commits are ok, although I wonder if "a use
dependency" is correct.  I learned at school that "an" is used in front
of vowels, though I may have missed the exceptions because of sleeping
in class.
 The explanations of the slot operators are a bit hard to read, maybe
rephrasing (and splitting in more sentences) is the way to go here.
 Also I wonder if doexample and doinclude are good additions, but I
have no strong opinion about it.
 Another thing: You should use \featurelabel not in a separate line but
at the beginning of the fist line or at the end of the paragraph you
want to mark, currently the margin marks aren't perfect.

Something different: I pulled from the eapi-3 branch and made my
patches apply on top of it:

i) cheat sheet for EAPI 3
ii) pms.cls
iii) better page layout

They are not ready for shipping and I want to wait for EAPI 3 to settle.

> 725d5ae..1c311de is formatting for the new margin labels thing.
> This'll hopefully get modified before we go live with it.

 You want the page layout patches beforehand?

V-Li

-- 
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode

<URL:http://gentoo.faulhammer.org/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [gentoo-pms] EAPI 3 branch could use some reviewing

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 1695 bytes --]

On Sun, 12 Apr 2009 15:31:26 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > I think I've removed all the TODO items and included everything
> > that's on the "possible" list for EAPI 3 now. I'd appreciate it if
> > people could give this a review before I send it to -dev@ and the
> > Council.
> 
>  As far as I can see the commits are ok, although I wonder if "a use
> dependency" is correct.  I learned at school that "an" is used in
> front of vowels, though I may have missed the exceptions because of
> sleeping in class.

It's how you pronounce it, not how you spell it. A yoose dependency, an
x-ray.

>  The explanations of the slot operators are a bit hard to read, maybe
> rephrasing (and splitting in more sentences) is the way to go here.

I suspect those're hard to read because people are expecting a
user-centric description of what they're for, rather than a package
manager centric description of how they behave.

>  Also I wonder if doexample and doinclude are good additions, but I
> have no strong opinion about it.

Yeah, dunno if they'll make the final cut.

>  Another thing: You should use \featurelabel not in a separate line
> but at the beginning of the fist line or at the end of the paragraph
> you want to mark, currently the margin marks aren't perfect.

Okay.

> > 725d5ae..1c311de is formatting for the new margin labels thing.
> > This'll hopefully get modified before we go live with it.
> 
>  You want the page layout patches beforehand?

I'd prefer to get decent page layout things in earlier rather than
later if possible please.

-- 
Ciaran McCreesh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [gentoo-pms] EAPI 3 branch could use some reviewing

[Christian Faulhammer]

[-- Attachment #1: Type: text/plain, Size: 952 bytes --]

Hi,

Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> On Sun, 12 Apr 2009 15:31:26 +0200
> Christian Faulhammer <fauli@gentoo.org> wrote:
> >  The explanations of the slot operators are a bit hard to read,
> > maybe rephrasing (and splitting in more sentences) is the way to go
> > here.
>
> I suspect those're hard to read because people are expecting a
> user-centric description of what they're for, rather than a package
> manager centric description of how they behave.

 But also package manager coders are humans (at least the last time I
checked), and apart from accuracy a technical documentation needs
readability in its own special way.  I wrote enough "scientific" and
technical documents to be sure that small, easy to understand sentences
are better.

V-Li

-- 
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode

<URL:http://gentoo.faulhammer.org/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [gentoo-pms] EAPI 3 branch could use some reviewing

[Ciaran McCreesh]

[-- Attachment #1: Type: text/plain, Size: 1033 bytes --]

On Mon, 13 Apr 2009 10:49:44 +0200
Christian Faulhammer <fauli@gentoo.org> wrote:
> Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
> > On Sun, 12 Apr 2009 15:31:26 +0200
> > Christian Faulhammer <fauli@gentoo.org> wrote:
> > >  The explanations of the slot operators are a bit hard to read,
> > > maybe rephrasing (and splitting in more sentences) is the way to
> > > go here.
> >
> > I suspect those're hard to read because people are expecting a
> > user-centric description of what they're for, rather than a package
> > manager centric description of how they behave.
> 
>  But also package manager coders are humans (at least the last time I
> checked), and apart from accuracy a technical documentation needs
> readability in its own special way.  I wrote enough "scientific" and
> technical documents to be sure that small, easy to understand
> sentences are better.

Actually, looking at that... I don't really see anything off about it.
Which bit specifically don't you like?

-- 
Ciaran McCreesh

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]

Re: [gentoo-pms] EAPI 3 branch could use some reviewing

[Christian Faulhammer]

[-- Attachment #1: Type: text/plain, Size: 440 bytes --]

Hi,

Ciaran McCreesh <ciaran.mccreesh@googlemail.com>:
[slot operators wording]
> Actually, looking at that... I don't really see anything off about it.
> Which bit specifically don't you like?

 I needed several reads to get it...will think about something better.

V-Li

-- 
Christian Faulhammer, Gentoo Lisp project
<URL:http://www.gentoo.org/proj/en/lisp/>, #gentoo-lisp on FreeNode

<URL:http://gentoo.faulhammer.org/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 198 bytes --]