<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/xhtml; charset=utf-8">
</head>
<body>
<div style="font-family:sans-serif"><div style="white-space:normal">
<p dir="auto">On 25 Feb 2019, at 13:56, Faré wrote:</p>
<blockquote style="border-left:2px solid #777; color:#777; margin:0 0 5px; padding-left:5px">
<p dir="auto">On Mon, Feb 25, 2019 at 2:32 PM Robert Goldman <a href="mailto:rpgoldman@sift.info" style="color:#777">rpgoldman@sift.info</a> wrote:</p>
<blockquote style="border-left:2px solid #777; color:#999; margin:0 0 5px; padding-left:5px; border-left-color:#999">
<p dir="auto">The more we discuss this, the more I think it's a solution in search of a problem. Just using the standard ASDF file-inclusion capabilities (that Faré shows in his email) seems sufficient to me, and also keeps a nice uniformity -- if you want the long description, you ask for it, and you know it's a string. It also imposes a cost in complexity with only a conjectural benefit (who would consume the new pathname designations, and which library authors and maintainers would supply it?). If users are offended by the excess number of bytes, the macro facility is available.</p>
<p dir="auto">I prefer not to give the yak any more facial hair!</p>
</blockquote>
<p dir="auto">To be clear, I am not advocating any change to the ASDF source code;<br>
just a minor change to the ASDF documentation, to suggest users to use<br>
a pathname as metadata to inform documentation extracters and browsers<br>
to use a documentation file instead of large strings in the image.</p>
</blockquote>
<p dir="auto">I just grabbed the quicklisp bistro (thanks to Zach for instructions), and I find there are 3827 .asd files, of which only 420 use <code style="background-color:#F7F7F7; border-radius:3px; margin:0; padding:0 0.4em" bgcolor="#F7F7F7">:long-description</code> at all.</p>
<p dir="auto">Looks like at least some of them have Markdown files slurped into them. These are big, but is this really a problem for anyone? I suppose one loses the limited amount of metadata that one would get from having a pathname.</p>
<p dir="auto">I'm still not sure how telling people to use pathnames would help any one.</p>
<p dir="auto">Even if so, why not just add <code style="background-color:#F7F7F7; border-radius:3px; margin:0; padding:0 0.4em" bgcolor="#F7F7F7">:documentation-pathname</code>, and then no one will have to worry about type errors? I'd favor that -- I bet most people assume that metadata is filled with strings or at least string designators, unless told otherwise, and I think it's reasonable to let them continue to do so, and have metadata that clearly says whether it's an external file or not.</p>
</div>
</div>
</body>
</html>