Re: go importer documentation/exceptions

[Kaelyn <kaelyn.alexi@protonmail.com>]

------- Original Message -------
On Saturday, April 23rd, 2022 at 9:51 AM, jgart <jgart@dismail.de> wrote:


> Hi Guixers,
>
> Here's my experience of learning the right syntax for the go importer:
>
> 2022-04-23 16:27:42 <jgart> guix import go https://git.sr.ht/~emersion/chathistorysync@0.1.0
>
> 2022-04-23 16:27:53 <jgart> guix import go https://git.sr.ht/~emersion/chathistorysync@latest
>
> 2022-04-23 16:27:58 <jgart> I tried that too
>
> 2022-04-23 16:28:00 <jgart> and
>
> 2022-04-23 16:28:09 <jgart> guix import go https://git.sr.ht/~emersion/chathistorysync@v0.1.0
>
> 2022-04-23 16:28:28 <jgart> singpolyma: is this related to the issue you have open?
>
> 2022-04-23 16:29:41 <singpolyma> Do you get an error about a tag being missing?
>
> 2022-04-23 16:31:32 <jgart> here's the exact errors for all three attempts: https://paste.sr.ht/~whereiseveryone/dae9350b5680a3960e0e56c6b7c5da5660d3b8a6
>
> 2022-04-23 16:32:29 <jgart> looks like a 410: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410
>
> 2022-04-23 16:33:26 <jgart> guix import go git.sr.ht/~emersion/chathistorysync@0.1.0
>
> 2022-04-23 16:33:30 <jgart> this worked
>
>
> The Guix docs do not explicitly state that a uri like
> https://git.sr.ht/~emersion/chathistorysync@0.1.0 is not allowed:
>
> https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-import.html
>
> This leaves footguns for new users trying to use the go importer for the
> first time since a new user might want to just copy paste the go package's
> url into the terminal.
>
> Should we be explicit in the docs about what uri syntax is and is not allowed
> or should we provide better exceptions when the go importer blows up?

My $0.02: both would be best. Documenting the correct syntax instead of relying on error messages for that information makes for a much nicer user experience, as do better/clearer exceptions when a tool fails.

Cheers,
Kaelyn
>
> all best,
>
> jgart
>
> https://whereis.みんな/
> gemini://whereis.みんな/
> http://litterbox.whereis.みんな/