!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

413 Members
Discussion about documentation improvements around the Nix ecosystem83 Servers

Load older messages


SenderMessageTime
20 Jul 2023
@infinisil:matrix.orginfinisil pennae: I did apparently! Although there's some special handling for the first line 18:45:29
@pennae:matrix.eno.space@pennae:matrix.eno.spacenot sure the first line should be handled specially18:50:28
@pennae:matrix.eno.space@pennae:matrix.eno.spacedo you have an example where dedent would misbehave?18:50:39
@infinisil:matrix.orginfinisil

pennae: For cases like

/* This is some docs
For a function
*/
18:50:55
@pennae:matrix.eno.space@pennae:matrix.eno.space that would be handled by dedent(...).trim() 18:51:36
@infinisil:matrix.orginfinisil

Also:

/*
  Type: foo :: {
    x :: Int;
    y :: Bool;
  }
*/ 
18:52:00
@infinisil:matrix.orginfinisil
In reply to @pennae:matrix.eno.space
that would be handled by dedent(...).trim()
Ahh 🤔
18:52:19
@infinisil:matrix.orginfinisilYeah lemme try dedent then :)18:52:30
@pennae:matrix.eno.space@pennae:matrix.eno.space
In reply to @infinisil:matrix.org

Also:

/*
  Type: foo :: {
    x :: Int;
    y :: Bool;
  }
*/ 
that too? dedent ignores the first line, the rest is dedented by two spaces
18:52:31
@infinisil:matrix.orginfinisil pennae: Are you sure? The docs don't mention anything of that 18:53:43
@infinisil:matrix.orginfinisilAnyways, I'll just try it out18:53:47
@infinisil:matrix.orginfinisilYeah it doesn't treat the first line differently19:01:12
@infinisil:matrix.orginfinisil pennae: Was able to use it though, thanks for the suggestion, PR updated 19:14:48
@pennae:matrix.eno.space@pennae:matrix.eno.spacewe do have an overabundance of doxygen-style comments in lib docs, we can't help but notice :D19:16:54
21 Jul 2023
@spacekookie:fairydust.spacekookie changed their display name from kookie (offline) to kookie.07:59:26
@domenkozar:matrix.orgDomen Kožar changed their profile picture.12:30:59
@asymmetric:matrix.dapp.org.ukasymmetric This RFC proposing documenting support tiers got merged, but I can't find any mention of support tiers in nixpkgs+nixos manuals. Am I looking in the wrong place? 16:41:50
@infinisil:matrix.orginfinisil asymmetric: RFC 46 introduced the support tiers: https://github.com/NixOS/rfcs/pull/46 16:43:48
@infinisil:matrix.orginfinisilMaybe it was never properly implemented by documenting it anywhere..16:44:00
@infinisil:matrix.orginfinisil(other than the RFC)16:44:04
@asymmetric:matrix.dapp.org.ukasymmetricyeah, that's what i'm thinking.. ☹️16:44:26
@asymmetric:matrix.dapp.org.ukasymmetricit's kinda suprising how sometimes RFC end up merged but not implemented /rant16:44:52
@asymmetric:matrix.dapp.org.ukasymmetric * it's kinda suprising how sometimes RFCs end up merged but not implemented /rant16:44:57
@asymmetric:matrix.dapp.org.ukasymmetricthis seems to be the last state of the conversation re: documenting the tiers: https://github.com/NixOS/rfcs/pull/46#issuecomment-66901914816:46:37
@infinisil:matrix.orginfinisilOnly like 3 years too late 🙃16:47:15
@toonn:matrix.orgtoonn asymmetric: When I tried getting something started (https://github.com/NixOS/nixpkgs/pull/143732) there was not much motivation to discuss past "these strings aren't informative enough." 22:21:45
@raitobezarius:matrix.orgraitobezariusI think implementing directly22:36:30
@raitobezarius:matrix.orgraitobezarius

I'm not sure that lib/systems/supported.nix contains sufficient information to serve as the platform tier list. This file is just the system doubles, and the support tier needs to take into account libc (musl/glibc), static/dynamic linking, gcc/clang, ABI, etc. If anything I think lib/systems/supported.nix would be autogenerated from the platform list, rather than the other way around.

22:36:31
@raitobezarius:matrix.orgraitobezarius *

I'm not sure that lib/systems/supported.nix contains sufficient information to serve as the platform tier list. This file is just the system doubles, and the support tier needs to take into account libc (musl/glibc), static/dynamic linking, gcc/clang, ABI, etc. If anything I think lib/systems/supported.nix would be autogenerated from the platform list, rather than the other way around.

22:36:33
@raitobezarius:matrix.orgraitobezariuswould probably fly22:36:36

Show newer messages


Back to Room ListRoom Version: 6