Re: [PATCH v2 2/9] regex.3: improve REG_STARTEND

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



At 2023-04-20T13:13:29+0200, наб wrote:
> On Thu, Apr 20, 2023 at 05:00:59AM -0500, G. Branden Robinson wrote:
> > At 2023-04-20T01:23:14+0200, наб wrote:
> > > +> 0), they overwrite
> > > +.I pmatch
> > > +as usual, and the
> > > +.B Byte offsets
> > > +remain relative to
> > > +.IR string
> > I don't think "byte" needs to be captialized here.
> I'm using it as a Sx and the section is capitalised,
> so I think this should also be?

[Note for non-mdoc(7) speakers: `Sx` is its macro for (sub)section
heading cross references.  man(7) doesn't have an equivalent, though if
there is demand, I'm happy to implement one.  :D]

Nothing I can see in man-pages(7) suggests that references to
(sub)section headings should be in an unusual typeface.  The norm in
English is usually to quote them.  It's also unusual to pun a
(sub)section heading name as an ordinary noun phrase this way.

So in this case I would neither capitalize _nor_ embolden the phrase.
After a piece of domain-specific jargon has been introduced in technical
writing (usually with italics), it is not thereafter specially marked.
In long-form works, it may get a cross reference after it in parentheses
or a footnote if it hasn't been mentioned for dozens of pages and the
reader requires a reminder.  I don't think regex(3) is large enough to
warrant that consideration, and "byte offset" seems to have the meaning
that a programmer already familiar with the individual terms would
infer.

Just the usual style coaching, not a NAK.

Regards,
Branden

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux