Ryan Mulligan
ac1ae0a58e
doc: auto-generate asserts and attrset library docs
...
If all the docs are auto-generated, it should be easier to convert
them to Commonmark.
Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io >
Co-Authored-By: Silvan Mosberger <contact@infinisil.com >
2022-12-08 22:58:22 +01:00
Théophile Wallez
3f25903151
nixos/nixpkgs/doc: fix typo in the signature of attrsets.zipAttrs
2022-03-13 13:59:51 +01:00
Jan Tojnar
64d7a3266b
doc: Fix xref in functions description
...
This was accidentally broken by 3c78ad2561
2021-11-14 22:30:07 +01:00
Doron Behar
d74960e8db
Merge pull request #105494 from alunduil/missing-operator-mapAttr-doc
2021-08-07 17:14:41 +00:00
Jan Tojnar
3c78ad2561
doc: Use markdown syntax for xrefs
...
Syntax is taken from MyST:
https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Erlend Pedersen
3452a739d1
nixpkgs-manual: lib.attrsets.mapAttrsToList returns a list ( #122179 )
2021-05-08 13:55:11 +02:00
Florian Engel
22cb630a66
Fix type description for attrByPath
...
The output type was missing
2021-03-14 10:27:26 +01:00
Robert Hensing
7d551ead60
doc: Format
2021-03-04 18:10:57 +01:00
Doron Behar
c858d0f63a
Merge pull request #105492 from alunduil/assertOneOf-typo
2021-02-07 18:44:50 +02:00
Jacek Galowicz
123045a570
lib/attrsets: add cartesianProductOfSets function
2021-01-28 23:08:59 +01:00
Alex Brandt
11b6ded912
nixos/nixpkgs/doc: add missing operator to attrsets.mapAttrs example.
...
It looks like this operator was missing (just a dropped +) unless I'm
missing something unexpected about the Nix syntax I've forgotten.
2020-11-30 21:19:50 +00:00
Alex Brandt
195fe01e8b
nixos/nixpkgs/docs: fix typo in assertOneOf example
...
This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either. This ensures the example is consistent
with the logic being presented.
2020-11-30 20:56:33 +00:00
Robert Hensing
e38a01db5d
Merge pull request #68491 from roberth/fix-dontRecurseIntoAttrs
...
Fix dontRecurseIntoAttrs + add to lib + doc
2020-03-01 11:05:34 +01:00
ivann
9605addd32
fix catAttrs documentation signature
2020-01-12 00:04:18 +01:00
Jan Tojnar
83c2ad80ca
doc: re-format
2019-09-18 22:12:54 +02:00
Robert Hensing
a96f37db10
Document attrsets.recurseIntoAttrs
2019-09-11 14:55:23 +02:00
Graham Christensen
0eb3b93e1a
nixpkgs docs: document recursivelyUpdate
2018-10-12 16:54:34 -04:00
Graham Christensen
c100a456b1
nixpkgs docs: document recursivelyUpdateUntil
2018-10-12 16:54:34 -04:00
Graham Christensen
77140a9075
nixpkgs docs: document zipAttrs
2018-10-12 16:54:34 -04:00
Graham Christensen
655a5fa8bf
nixpkgs docs: document zipAttrsWith
2018-10-12 16:54:34 -04:00
Graham Christensen
4edb31882c
nixpkgs docs: Clarify zipAttrsWithNames's docs
2018-10-12 16:54:33 -04:00
Graham Christensen
3b3bde463b
nixpkgs docs: document zipAttrsWithNames
2018-10-12 16:06:12 -04:00
Graham Christensen
e0c6981d19
nixpkgs docs: document optionalAttrs
2018-10-12 16:06:12 -04:00
Graham Christensen
c547c3fe82
nixpkgs docs: document toDerivation
2018-10-12 16:06:12 -04:00
Graham Christensen
f85a4ba9c3
nixpkgs docs: document isDerivation
2018-10-12 16:06:11 -04:00
Graham Christensen
ef05e1057b
nixpkgs docs: document genAttrs
2018-10-12 16:06:11 -04:00
Graham Christensen
d664b8f5e3
nixpkgs docs: document mapAttrsRecursiveCond
2018-10-12 16:06:11 -04:00
Graham Christensen
e7549b96ad
nixpkgs docs: finish up mapAttrsRecursive
2018-10-12 16:06:11 -04:00
Graham Christensen
5daee73ce4
Generate links to function definitions
...
Hydra passes the full revision in to the input, which we pass through.
If we don't get this ,we try to get it from other sources, or default to
master which should have the definition in a close-ish location.
All published docs should have theURL resolve properly, only local
hackers will have the link break.
2018-10-05 11:20:46 -04:00
Graham Christensen
f835f77e02
nixpkgs: Start documenting library functions in XML
...
Covers assert functions and about half of the attrsets functions.
Some internal consistency around IDs could be improved.
2018-10-05 10:06:08 -04:00
