bartronx7/guix
1
0
Fork 0
mirror of https://codeberg.org/guix/guix.git synced 2026-01-25 03:55:08 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

import/utils: Wrap terms starting with @ in descriptions.

Browse source 
* tests/import-utils.scm ("beautify-description: escape @stuff"): Add test.
* guix/import/utils.scm (beautify-description): Also wrap terms in @code{...}
that start with an escaped @.

Change-Id: I424f626635b821af6f4c16c97b8724cdaf99de45
This commit is contained in:
Ricardo Wurmus 2025-02-11 22:11:45 +01:00
parent 36c9996b75
commit 729bfe3689
No known key found for this signature in database
GPG key ID: 197A5888235FACAC
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
guix/import/utils.scm
View file

@ -342,12 +342,12 @@ LENGTH characters."
;; Escape single @ to prevent it from being understood as
;; invalid Texinfo syntax.
(cut regexp-substitute/global #f "@" <> 'pre "@@" 'post)
;; Wrap camelCase or PascalCase words or text followed
;; immediately by "()" in @code{...}.
;; Wrap camelCase, PascalCase words, text followed
;; immediately by "()", or text starting with "@@" in @code{...}.
(lambda (word)
(let ((pattern
(make-regexp
"([A-Z][a-z]+[A-Z]|[a-z]+[A-Z]|.+\\(\\))")))
"((@@)?[A-Z][a-z]+[A-Z]|(@@)?[a-z]+[A-Z]|(@@)?.+\\(\\))")))
(match (list-matches pattern word)
(() word)
((m . rest)

4
tests/import-utils.scm
View file

@ -53,6 +53,10 @@ Differences are hard to spot, e.g. in CLOS vs. GOOPS."))
"This @@ is not Texinfo syntax. Neither is this %@@>%."
(beautify-description "This @ is not Texinfo syntax. Neither is this %@>%."))
(test-equal "beautify-description: escape @stuff"
"This is not valid syntax: @code{@@importFrom} oh dear."
(beautify-description "This is not valid syntax: @importFrom oh dear."))
(test-equal "beautify-description: wrap PascalCase words in @code"
"The term @code{DelayedMatrix} refers to a class."
(beautify-description "The term DelayedMatrix refers to a class."))