IRC channel logs

2024-04-25.log

back to list of logs

<cow_2001>is there a style guide for docstrings?
<cow_2001>i'm working on this here https://codeberg.org/kakafarm/guile-srfi-189/compare/master...add-docstrings
<cow_2001>i am confused about texinfo appearing in docstrings. for example, srfi-1's definition of assoc in /module/srfi/srfi-1.scm has a bunch of Texinfo markup, and i don't see any special rendering of it in the interactive guile session or in Geiser's C-c C-d C-d (geiser-doc-symbol-at-point).
<cow_2001>text in the guile manual's srfi-1 text under "assoc" is very different from the srfi-1 assoc docstring
<euouae>Hello how is (ice-9 documentation) to be used?
<euouae>I was told to use <https://luis-felipe.gitlab.io/guile-documenta/> and I'm wondering if that's what I should go for?
<sailorCat>Does guildhall alive? I've tried it but looks like the recommended repo: http://shift-reset.com/doro/ is out of the service.
<euouae>sailorCat: from what I can recall there is no package manager
<euouae>There's <https://gitlab.com/a-sassmannshausen/guile-hall> which is in alpha
<euouae>sailorCat: there's also <https://www.nongnu.org/guile-lib/>
<euouae>this is pretty small stuff though
<euouae>and it seems very recently revided
<euouae>revived*
<sailorCat>ok
<ArneBab_>cow_2001: have a look at guild doc-snarf, I I think that may be the reason.
<ArneBab_>It can output as texinfo
<ArneBab_>daviid: do you have a rule of thumb how you name modules in guile-lib? I’d like to finally contribute doctest but am not sure where to put it. (scheme doctest) or (test doctest) or just (doctest), or maybe some other?
<ArneBab_>(it would be nice to have a guideline on that in HACKING)
<cow_2001>ArneBab_: oooh
<cow_2001>no, i don't get it.
<sneek>Welcome back janneke :)
<sneek>Yey! abcdw is back
<sneek>wb dsmith!!
<cow_2001>ArneBab: i don't get any output relating to the docstrings when using that command
<cow_2001>i get one comment and another about inexact numbers, when using it on srfi-1.scm
<cow_2001>so i'm still confused
<cow_2001>ArneBab: okay, i get it now. guile-snarf takes the C code docstrings and these bits of texinfo goes into the guile manual and also into the auto generated guile library?
<cow_2001>but then again the guile docstrings aren't in the manual
<cow_2001>at least two i've searched
<cow_2001>but i did find scm_foo stuff in the manual