Hi Branden, [Disclaimer: this message contains a large amount of Spanish quoted text]
On Tue, Sep 30, 2025 at 07:32:46AM -0500, G. Branden Robinson wrote: > > > +is lazy\[em]akin to calling > > > > I prefer em dashes in both sides of the parenthetical; it more clearly > > denotes where it ends. > > > > is lazy > > \[em]akin to calling > > .BR umount2 (2) > > with > > .BR MOUNT_DETACH \[em]; > > > > (I assume that's where it ends.) > > I'm uneasy about the acceptability of setting an em dash and semicolon > adjacently like this. I checked my copy of the Chicago Manual of Style > (18th ed., 2024) and it has something close, but not squarely, on point. I think Spanish rules are much *much* better in this regard. <https://www.rae.es/ortograf%C3%ADa/concurrencia-con-otros-signos-4> | 3.4.7.3. Concurrencia con otros signos | | Cuando las rayas que encierran incisos concurren con otros signos de | puntuación, siguen las mismas reglas expuestas para los paréntesis | (v. § 3.4.5.3). | | Para las peculiaridades propias de los textos narrativos, | v. § 3.4.7.1.3. It says it follows the same rules as parentheses. If we follow § 3.4.5.3 --rules for parentheses--, it has some gems. <https://www.rae.es/ortograf%C3%ADa/concurrencia-con-otros-signos-2#3.4.5.3> | 3.4.5.3. Concurrencia con otros signos | | Cuando, en su uso delimitador, los paréntesis concurren con otros | signos de puntuación, deben seguirse las siguientes pautas: | | a) Los delimitadores principales (punto, coma, punto y coma, y | dos puntos) se escriben siempre después del paréntesis de | cierre: | | Llevaban casados mucho tiempo (el año pasado cumplieron | sus bodas de oro), pero nunca lograron entenderse. | | Se llama Elvira Muñoz (si no recuerdo mal). | [... here go some paragraphs that I'll skip, as they're unrelated to what we're discussing, and also I find them a bit inconsistent with the rest of the rules, which are quite consistent. ...] | | b) Si coinciden tras una palabra dos o más signos dobles, se | cerrará primero el que se haya abierto en último lugar: | | «Creo que el motor de esos fenómenos es la vanidad (la | tentación del “¿por qué no yo?”), que lleva a preferir | el cero al número dos» (Abc [Esp.] 16.1.1987). | | c) Como ya se ha señalado, el texto contenido dentro de los | paréntesis tiene su propia puntuación, independiente de la | del enunciado principal: | | La manía de Ernesto por el coleccionismo (lo colecciona | todo: sellos, monedas, relojes, plumas, llaveros…) ha | convertido su casa en un almacén. | | Por ello, si la secuencia escrita entre paréntesis es | interrogativa o exclamativa, los signos de interrogación o de | exclamación deben colocarse dentro de los paréntesis: | | Su facilidad para los idiomas (¡habla con fluidez siete | lenguas!) le ha abierto muchas puertas. | | En cambio, cuando la secuencia interrogativa o exclamativa | constituye una unidad mayor que la encerrada entre | paréntesis, los signos de interrogación y exclamación se | escriben fuera de los paréntesis: | | ¿Cuántos países integran la ONU (Organización de las | Naciones Unidas)? | | Lo mismo cabe decir de los puntos suspensivos, que preceden | al paréntesis de cierre si corresponden solo al segundo | discurso, mientras que se escriben tras el paréntesis si | afectan al discurso principal: | | Conté lentamente (uno, dos, tres…) y me di la vuelta. | | Visitamos el museo de la ciudad, las calles del centro | histórico, las montañas cercanas (¡impresionantes!)… | Acabamos agotados. And then if we read the description of "la raya", it has some nice examples of use: <https://www.rae.es/ortograf%C3%ADa/la-raya-como-signo-delimitador#3.4.7.1> | 3.4.7.1. La raya como signo delimitador | | Cuando es un signo doble, la raya forma parte del grupo de signos | delimitadores que introducen o encierran un segundo discurso. Su | función principal es indicar que las unidades lingüísticas que aísla | no son una parte central del mensaje, sino que constituyen un discurso | secundario que se inserta en el discurso principal para introducir | información complementaria: | | «El segundo festival de música mexicana es —¡cómo ponerlo en | duda!— el acontecimiento musical más importante del año» (Melo | Notas [Méx. 1990]). | | «No daba importancia a los viajes de su mujer. “Que se | distraiga —decía—, que se distraiga”» (Palou Carne [Esp. 1975]). | | Como discurso autónomo con respecto al principal, las secuencias | encerradas entre rayas pueden tener puntuación propia: | | «Aguzando el oído —en el fondo, sin necesidad de concentrarse mucho: | bastaba con dejar de prestar atención a los latidos del propio | corazón, con sosegarse—, era fácil percibir un rumor de voces» | (Azancot Amores [Esp. 1980]). | | En su función delimitadora de un segundo discurso, las rayas tienen | los usos que se comentan a continuación. | | 3.4.7.1.1 En incisos | | Las rayas se emplean, como signo doble, para encerrar incisos: | | Para él la fidelidad —cualidad que valoraba por encima de | cualquier otra— era algo sagrado. | | En este uso pueden utilizarse también las comas o los paréntesis. Los | incisos entre rayas suponen un aislamiento mayor con respecto al texto | en el que se insertan que los que se escriben entre comas, pero menor | que los que se escriben entre paréntesis (sobre otras diferencias | entre el uso del paréntesis o la raya, frente a la coma, para | delimitar incisos, v. § 3.4.5.1.1). La raya de cierre en los incisos | no se suprime aunque detrás de ella deba aparecer un punto o cualquier | otro signo de puntuación: | | Esperaba a Emilio —un gran amigo—. Lamentablemente, no vino. | | Esperaba a Emilio —un gran amigo—, que, lamentablemente, no vino. | | Tampoco debe suprimirse la raya de cierre cuando el inciso ocupa la | posición final del enunciado: | | La editorial ha publicado este año varias obras del autor —todas | ellas de su primera época—. | | Deben evitarse puntuaciones redundantes, como la del siguiente | ejemplo, donde debieron escribirse o comas o rayas, pero no ambos | signos: ⊗ «La muerte vivida por los demás, —sea la muerte por | accidente o de otros modos—, es una cosa que sufrimos mucho» (Burgos | Rigoberta [Guat. 1983]). | | 3.4.7.1.2 En incisos incluidos en otros incisos | | Deben usarse las rayas para introducir una nueva aclaración o inciso | en un texto ya encerrado entre paréntesis: | | Si desea más información sobre este tema (la bibliografía | existente —incluso en español— es bastante extensa), deberá | acudir a otras fuentes. | | Para intercalar algún dato o precisión en un inciso escrito entre | rayas, han de usarse los paréntesis (v. § 3.4.5.1.2): Venezuela | —primer lugar de tierra firme avistado por Colón en su tercer viaje a | América (1498)— tenía, por aquel entonces, unos 300 000 habitantes. | | 3.4.7.1.3 Para enmarcar comentarios de un narrador o transcriptor | | Las rayas se usan para enmarcar, en medio de una cita textual | entrecomillada, las aclaraciones del transcriptor con respecto a su | autoría: | | «Es imprescindible —señaló el ministro— que se refuercen los | sistemas de control sanitario en las fronteras». | | Se usa, en cambio, la coma cuando la aclaración aparece en posición | final, fuera del texto entrecomillado: | | «Es imprescindible que se refuercen los sistemas de control | sanitario en las fronteras», señaló el ministro. | [...] I plan to eventually go through all the pages and make sure em dashes follow these rules. > > ---snip--- > §6.95. Em dashes and other punctuation. In modern usage, a question > mark or an exclamation point—but never a comma, a colon, or a semicolon— > may precede an em dash. ... If the context calls for an em dash where a > comma would ordinarily separate a dependent clause from an independent > clause, the comma is omitted. > ---end snip--- I think the Spanish rules for the em dash result in more logic text, which is easier to parse. I'm going to ignore this style, even if it's the more common one in English texts. > > Here's the full sentence at issue. > > >>> +(Note that the unmount operation on > >>> +.BR close (2) > >>> +is lazy\[em]akin to calling > >>> +.BR umount2 (2) > >>> +with > >>> +.BR MOUNT_DETACH ; > >>> +any existing open references to files > >>> +from the mount object > >>> +will continue to work, > >>> +and the mount object will only be completely destroyed > >>> +once it ceases to be busy.) > > This construction uses a semicolon rather than a comma, and that > semicolon separates two independent clauses. (Whether "Note that" is > retained or deleted makes no difference.) > > CMoS therefore doesn't flag this as "wrong", but I think it'll look > weird to a native English reader and maybe to non-native ones, too. > > The best solution might be to recast. It's seldom wrong to break a > sentence using a semicolon into two sentences when the purpose of the > prose is to explain rather than specify. > > > You need to escape dashes in manual pages. Otherwise, they're > > formatted as hyphens, > > s/they're/they can be/ > > Some distributions, like Arch[1], Debian[2], and Fedora[3], won't > exhibit this problem. Why doesn't groff do this upstream? Because some > groff users _do_ care about correct typesetting, and it's more > straightforward for distributors to patch their packages as the > aforementioned have done than for groff to adopt that as a default and > leave people to their own devices to revert it.[4] > > (Maybe I should copy some of that rationale into groff's "PROBLEMS" > file. Opinions?) > > > which can't be pasted into the terminal (and another consequence is > > not being able to search for them in the man(1) reader with literal > > dashes). > > ...but if you're looking for an incorrectly hyphenated term like > "foo-bar", you _can_ search for "foo.bar". Both the more(1) and less(1) > in the (now over 2 years old) Debian Bookworm can manage this on > UTF-8-encoded input. Except that if "foo bar" appears frequently in the text, using foo.bar will be painful (has happened to me). But at least it's better than not being able to search it at all. :) > > > Depending on your system, you might be able to search for them or paste > > them to the terminal, because some distros patch this in > > /etc/local/an.tmac, > > That's not the file name any of the foregoing distributors use, but > you've got the right idea. Oops, I meant to say */groff/*, not */local/*. 'local' was hot in cache in my brain for some reason, and overwrote some register. > > at the expense of generating lower quality pages, but in general don't > > rely on that. > > > > I've noticed now, but this probably also happens in previous pages in > > this patch set. > > > > While at it, you should also use a non-breaking space, to keep the > > entire command in the same line. > > > > .IR \%mount\~\-\-bind ) > > Here's where I disagree a little. Lengthy unhyphenable character > sequences like this can lead to ugly formatting, even when adjustment is > disabled. (A ragged right margin can get _really_ ragged.) I see what you mean, but I wouldn't count this as lengthy. > While I personally would not use italics for inline examples (and don't > in groff man pages), regardless of the font style you use, you can > surround multi-word inline examples with quotation marks so that they > are properly understood even if broken. (Further, no font style > selection survives copy-and-paste into plain text email.) > > The Linux man-pages don't require portability to AT&T troff, so you can > achieve this with groff's `lq` and `rq` special characters. > > I therefore propose: > > .RI \[lq] \%mount > .IR \-\-bind \[rq] I would still make it unbreakable. It's short enough that it's more readable in the same line. And if it were long enough, I'd make it an EX/EE example. The portability of \[lq] and \[rq] is fine; I'm already relying on groffisms. :) [...] > Quotation is a useful and important linguistic facility. It's a shame > man page authors have neglected it so long. I might switch to it, eventually. I'd consider using both I and quotes, maybe. We'll see. As a colleague I had at nginx says, the term is "eventually". ;-) > Regards, > Branden Have a lovely night! Alex > > [1] > https://gitlab.archlinux.org/archlinux/packaging/packages/groff/-/commit/e474b541a32fc905b4f748de0313acfb8b98c081 > [2] > https://salsa.debian.org/debian/groff/-/commit/d5394c68d70e6c5199b01d2522e094c8fd52e64e > [3] https://bodhi.fedoraproject.org/updates/FEDORA-2023-f5d1e63191 > [4] https://lwn.net/Articles/948616/ -- <https://www.alejandro-colomar.es> Use port 80 (that is, <...:80/>).
signature.asc
Description: PGP signature
