Code

[RFC 0145] Doc-comments#145

Code

Merged

kevincox merged 116 commits intoNixOS:masterNixOS/rfcs:masterfrom hsjobeki:feat/doc-stringshsjobeki/rfcs:feat/doc-stringsCopy head branch name to clipboardNov 29, 2023

+506

Commits

Commits on Mar 29, 2023

• init: rfc about docs-string format

  hsjobeki

  committed
  af461dd

  Copy full SHA for af461dd

• init: rfc number

  hsjobeki

  committed
  dee60aa

  Copy full SHA for dee60aa

• fix some major spelling issues

  hsjobeki

  committed
  4508831

  Copy full SHA for 4508831

• gramatical cleanup

  hsjobeki

  committed
  34bf50e

  Copy full SHA for 34bf50e

• gramatical cleanup

  hsjobeki

  committed
  130d9e5

  Copy full SHA for 130d9e5

• fix: consistent naming: doc-string(s)

  hsjobeki

  committed
  ab0aa26

  Copy full SHA for ab0aa26

• Update rfcs/0145-doc-strings.md

  Show description for 2b0dea2
  

  hsjobeki

  and

  figsoda

  authored
  2b0dea2

  Copy full SHA for 2b0dea2

• make statement more clear

  hsjobeki

  committed
  a3ee89a

  Copy full SHA for a3ee89a

• add statement what a sections is

  hsjobeki

  committed
  e1a7475

  Copy full SHA for e1a7475

• remove empty example

  hsjobeki

  committed
  d7e0cf5

  Copy full SHA for d7e0cf5

Commits on Mar 30, 2023

• Update rfcs/0145-doc-strings.md

  Show description for 4d69893
  

  hsjobeki

  and

  figsoda

  authored
  4d69893

  Copy full SHA for 4d69893

• add: more examples, explanations

  hsjobeki

  committed
  b4a1297

  Copy full SHA for b4a1297

• Update 0145-doc-strings.md

  hsjobeki

  authored
  f6bd84f

  Copy full SHA for f6bd84f

• Update 0145-doc-strings.md

  hsjobeki

  authored
  4d2329a

  Copy full SHA for 4d2329a

• Update rfcs/0145-doc-strings.md

  Show description for 402f065
  

  hsjobeki

  and

  AndersonTorres

  authored
  402f065

  Copy full SHA for 402f065

Commits on Mar 31, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  fa2cb38

  Copy full SHA for fa2cb38

Commits on Apr 1, 2023

• Update rfcs/0145-doc-strings.md

  Show description for 2fdb3c2
  

  hsjobeki

  and

  AndersonTorres

  authored
  2fdb3c2

  Copy full SHA for 2fdb3c2

• Update rfcs/0145-doc-strings.md

  Show description for 805a8e1
  

  hsjobeki

  and

  AndersonTorres

  authored
  805a8e1

  Copy full SHA for 805a8e1

• Update rfcs/0145-doc-strings.md

  Show description for c9d19a6
  

  hsjobeki

  and

  AndersonTorres

  authored
  c9d19a6

  Copy full SHA for c9d19a6

Commits on Apr 2, 2023

• Merge branch 'NixOS:master' into feat/doc-strings

  hsjobeki

  authored
  83ebf36

  Copy full SHA for 83ebf36

• Restructuring

  Show description for e677af5
  hsjobeki

  authored
  e677af5

  Copy full SHA for e677af5

• Update 0145-doc-strings.md

  hsjobeki

  authored
  84b29fb

  Copy full SHA for 84b29fb

• fix some minor grammar mistakes

  hsjobeki

  authored
  d5e3083

  Copy full SHA for d5e3083

Commits on Apr 4, 2023

• Consolidate into one big table

  Show description for 6fc5a41
  hsjobeki

  authored
  6fc5a41

  Copy full SHA for 6fc5a41

• Update 0145-doc-strings.md

  hsjobeki

  authored
  d546b39

  Copy full SHA for d546b39

• Extend references

  hsjobeki

  authored
  9f9c5d7

  Copy full SHA for 9f9c5d7

• Update 0145-doc-strings.md

  hsjobeki

  authored
  29eea3e

  Copy full SHA for 29eea3e

• Update 0145-doc-strings.md

  hsjobeki

  authored
  1894149

  Copy full SHA for 1894149

• Update 0145-doc-strings.md

  hsjobeki

  authored
  b511aa1

  Copy full SHA for b511aa1

Commits on Apr 5, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  a9e380b

  Copy full SHA for a9e380b

Commits on Apr 6, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  9ac29d9

  Copy full SHA for 9ac29d9

• Update 0145-doc-strings.md

  hsjobeki

  authored
  1b5e5ef

  Copy full SHA for 1b5e5ef

• update

  hsjobeki

  committed
  498b045

  Copy full SHA for 498b045

• update

  hsjobeki

  committed
  6d47a93

  Copy full SHA for 6d47a93

• update

  hsjobeki

  committed
  14dca53

  Copy full SHA for 14dca53

• work feedback into it

  hsjobeki

  committed
  fe8ab29

  Copy full SHA for fe8ab29

• Work feedback into document

  Show description for 967136c
  hsjobeki

  authored
  967136c

  Copy full SHA for 967136c

• point to type checking

  hsjobeki

  committed
  b581941

  Copy full SHA for b581941

• Update rfcs/0145-doc-strings.md

  Show description for 1f5bf5e
  

  hsjobeki

  and

  AndersonTorres

  authored
  1f5bf5e

  Copy full SHA for 1f5bf5e

Commits on Apr 7, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  c8e85f3

  Copy full SHA for c8e85f3

Commits on Apr 8, 2023

• Add roberth's PR from 2017

  hsjobeki

  authored
  5da22b4

  Copy full SHA for 5da22b4

• Update rfcs/0145-doc-strings.md

  Show description for 434f8b4
  

  hsjobeki

  and

  gilice

  authored
  434f8b4

  Copy full SHA for 434f8b4

• Update rfcs/0145-doc-strings.md

  Show description for 1105ea3
  

  hsjobeki

  and

  gilice

  authored
  1105ea3

  Copy full SHA for 1105ea3

• Update rfcs/0145-doc-strings.md

  Show description for cb7f9d6
  

  hsjobeki

  and

  gilice

  authored
  cb7f9d6

  Copy full SHA for cb7f9d6

• Update 0145-doc-strings.md

  hsjobeki

  authored
  e5397ee

  Copy full SHA for e5397ee

Commits on Apr 9, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  403b8cd

  Copy full SHA for 403b8cd

• Add multiline doc string draft

  hsjobeki

  authored
  f7b4fb4

  Copy full SHA for f7b4fb4

Commits on Apr 12, 2023

• add: point to the concerns

  hsjobeki

  authored
  40a51a1

  Copy full SHA for 40a51a1

• add: motivation multiline comments

  hsjobeki

  authored
  254863e

  Copy full SHA for 254863e

Commits on Apr 14, 2023

• Feedback from docs-team

  hsjobeki

  authored
  acb9815

  Copy full SHA for acb9815

Commits on Apr 17, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  86475de

  Copy full SHA for 86475de

• Update 0145-doc-strings.md

  hsjobeki

  authored
  1097607

  Copy full SHA for 1097607

• Merge pull request #3 from hsjobeki/documentation-team-feedback

  Show description for 72b1c80
  hsjobeki

  authored
  72b1c80

  Copy full SHA for 72b1c80

• Update 0145-doc-strings.md

  Show description for b570f1c
  hsjobeki

  authored
  b570f1c

  Copy full SHA for b570f1c

• Update 0145-doc-strings.md

  hsjobeki

  authored
  48477b1

  Copy full SHA for 48477b1

Commits on Apr 20, 2023

• clearify: doc comment reference logic

  Show description for 3c1a8f7
  hsjobeki

  authored
  3c1a8f7

  Copy full SHA for 3c1a8f7

• Update rfcs/0145-doc-strings.md

  Show description for 834f8d4
  

  hsjobeki

  and

  AndersonTorres

  authored
  834f8d4

  Copy full SHA for 834f8d4

Commits on Apr 29, 2023

• Update rfcs/0145-doc-strings.md

  Show description for e693a28
  

  hsjobeki

  and

  flokli

  authored
  e693a28

  Copy full SHA for e693a28

• Update rfcs/0145-doc-strings.md

  Show description for fc92941
  

  hsjobeki

  and

  flokli

  authored
  fc92941

  Copy full SHA for fc92941

• Update rfcs/0145-doc-strings.md

  Show description for c30cb33
  

  hsjobeki

  and

  flokli

  authored
  c30cb33

  Copy full SHA for c30cb33

Commits on Apr 30, 2023

• Update rfcs/0145-doc-strings.md

  Show description for bf9cf3c
  

  hsjobeki

  and

  ony

  authored
  bf9cf3c

  Copy full SHA for bf9cf3c

• clarify & add some more examples

  hsjobeki

  committed
  caa849a

  Copy full SHA for caa849a

• Merge branch 'feat/doc-strings' of github.com:hsjobeki/rfcs into feat/doc-strings

  hsjobeki

  committed
  fcc76be

  Copy full SHA for fcc76be

• Update rfcs/0145-doc-strings.md

  Show description for 6790f9d
  

  hsjobeki

  and

  asymmetric

  authored
  6790f9d

  Copy full SHA for 6790f9d

• Update rfcs/0145-doc-strings.md

  Show description for 298955f
  

  hsjobeki

  and

  asymmetric

  authored
  298955f

  Copy full SHA for 298955f

• Update rfcs/0145-doc-strings.md

  Show description for 477c880
  

  hsjobeki

  and

  asymmetric

  authored
  477c880

  Copy full SHA for 477c880

• Update rfcs/0145-doc-strings.md

  Show description for 6d4a327
  

  hsjobeki

  and

  asymmetric

  authored
  6d4a327

  Copy full SHA for 6d4a327

• update nixdoc format according to current nixodc-maintainer

  Show description for e094210
  

  hsjobeki

  and

  asymmetric

  authored
  e094210

  Copy full SHA for e094210

• Update rfcs/0145-doc-strings.md

  Show description for 05c3c9d
  

  hsjobeki

  and

  flokli

  authored
  05c3c9d

  Copy full SHA for 05c3c9d

• Update 0145-doc-strings.md

  hsjobeki

  authored
  6ad8480

  Copy full SHA for 6ad8480

• Update 0145-doc-strings.md

  hsjobeki

  authored
  321fbce

  Copy full SHA for 321fbce

• Update 0145-doc-strings.md

  hsjobeki

  authored
  3066a3e

  Copy full SHA for 3066a3e

• Update 0145-doc-strings.md

  hsjobeki

  authored
  92919d7

  Copy full SHA for 92919d7

• Update 0145-doc-strings.md

  hsjobeki

  authored
  36adf87

  Copy full SHA for 36adf87

Commits on May 1, 2023

• Update rfcs/0145-doc-strings.md

  Show description for cd3cf33
  

  hsjobeki

  and

  asymmetric

  authored
  cd3cf33

  Copy full SHA for cd3cf33

Commits on May 6, 2023

• work feedback from @asymmetric in

  hsjobeki

  committed
  65d33a6

  Copy full SHA for 65d33a6

Commits on May 12, 2023

• Add @sternenseemann as sheperd

  hsjobeki

  authored
  56f25ca

  Copy full SHA for 56f25ca

Commits on Jul 31, 2023

• Add sheperd team members

  hsjobeki

  authored
  be8fa44

  Copy full SHA for be8fa44

• Apply suggestions from @asymmetric

  Show description for bb33f91
  

  hsjobeki

  and

  asymmetric

  authored
  bb33f91

  Copy full SHA for bb33f91

• Rework: improves content for problem targeting and readablity

  hsjobeki

  committed
  63321c4

  Copy full SHA for 63321c4

Commits on Sep 28, 2023

• Merge branch 'NixOS:master' into feat/doc-strings

  hsjobeki

  authored
  b4067a8

  Copy full SHA for b4067a8

• Clean up RFC according to meeting notes

  hsjobeki

  authored
  f146807

  Copy full SHA for f146807

Commits on Sep 29, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  4c8fc55

  Copy full SHA for 4c8fc55

• Update 0145-doc-strings.md

  hsjobeki

  authored
  273ace0

  Copy full SHA for 273ace0

• Update 0145-doc-strings.md

  hsjobeki

  authored
  ba8d6f5

  Copy full SHA for ba8d6f5

• Update 0145-doc-strings.md

  hsjobeki

  authored
  5599344

  Copy full SHA for 5599344

• Update 0145-doc-strings.md

  hsjobeki

  authored
  b986270

  Copy full SHA for b986270

• Update 0145-doc-strings.md

  hsjobeki

  authored
  b133e65

  Copy full SHA for b133e65

• Add non goal

  hsjobeki

  authored
  f415a11

  Copy full SHA for f415a11

Commits on Oct 26, 2023

• remove unnecessary sentence

  Show description for 6864009
  

  hsjobeki

  and

  Lassulus

  authored
  6864009

  Copy full SHA for 6864009

• Code has interface

  Show description for 174040a
  

  hsjobeki

  and

  roberth

  authored
  174040a

  Copy full SHA for 174040a

• More specific outer format

  Show description for b6bea69
  

  hsjobeki

  and

  roberth

  authored
  b6bea69

  Copy full SHA for b6bea69

• Single format simplifies tooling.

  Show description for 70bca5e
  

  hsjobeki

  and

  roberth

  authored
  70bca5e

  Copy full SHA for 70bca5e

• fix typo

  Show description for 72359a2
  

  hsjobeki

  and

  roberth

  authored
  72359a2

  Copy full SHA for 72359a2

Commits on Oct 27, 2023

• Typo

  Show description for 00e76a7
  

  hsjobeki

  and

  asymmetric

  authored
  00e76a7

  Copy full SHA for 00e76a7

• Correct statement about old pr

  Show description for d829157
  

  hsjobeki

  and

  roberth

  authored
  d829157

  Copy full SHA for d829157

• Dont overspecify whitespaces

  Show description for 1c1eacc
  

  hsjobeki

  and

  roberth

  authored
  1c1eacc

  Copy full SHA for 1c1eacc

• Update rfcs/0145-doc-strings.md

  Show description for 74820d5
  

  hsjobeki

  and

  asymmetric

  authored
  74820d5

  Copy full SHA for 74820d5

Commits on Oct 28, 2023

• strictly follow rfc72

  Show description for fedeadf
  

  hsjobeki

  and

  infinisil

  authored
  fedeadf

  Copy full SHA for fedeadf

Commits on Oct 29, 2023

• Attribute path leafs: add example

  hsjobeki

  authored
  4ee5636

  Copy full SHA for 4ee5636

• Update 0145-doc-strings.md

  hsjobeki

  authored
  cc333bd

  Copy full SHA for cc333bd

Commits on Oct 30, 2023

• Update 0145-doc-strings.md

  hsjobeki

  authored
  b26faa5

  Copy full SHA for b26faa5

Commits on Oct 31, 2023

• Specify documentable nodes. Not only expressions

  hsjobeki

  authored
  d6c2590

  Copy full SHA for d6c2590

• Update 0145-doc-strings.md

  hsjobeki

  authored
  fcc24cd

  Copy full SHA for fcc24cd

Commits on Nov 3, 2023

• typo: partial applications

  Show description for 51f5bcc
  

  hsjobeki

  and

  Adam Joseph

  authored
  51f5bcc

  Copy full SHA for 51f5bcc

Commits on Nov 4, 2023

• feedback from comment

  hsjobeki

  authored
  1e3f041

  Copy full SHA for 1e3f041

Commits on Nov 8, 2023

• Add migration example

  hsjobeki

  authored
  6471c42

  Copy full SHA for 6471c42

Commits on Nov 9, 2023

• Add link to codemod on migration example

  hsjobeki

  authored
  e6870a0

  Copy full SHA for e6870a0

• Add non goal: Styling of markdown

  hsjobeki

  authored
  9dcad4a

  Copy full SHA for 9dcad4a

• Call implementation comments

  hsjobeki

  authored
  4fa538f

  Copy full SHA for 4fa538f

• Update: Mental model about arguments

  hsjobeki

  authored
  005e34f

  Copy full SHA for 005e34f

• Move single line comments to future work

  hsjobeki

  authored
  6c74780

  Copy full SHA for 6c74780

• Remove partial lambda example

  hsjobeki

  authored
  a9dad7b

  Copy full SHA for a9dad7b

Commits on Nov 16, 2023

• fix typos

  hsjobeki

  authored
  2987912

  Copy full SHA for 2987912

Commits on Nov 19, 2023

• nix implementation is out of scope.

  Show description for e4a6dd7
  

  hsjobeki

  and

  Adam Joseph

  authored
  e4a6dd7

  Copy full SHA for e4a6dd7

Commits on Nov 20, 2023

• Add occurence details about /**/ and /** */

  hsjobeki

  authored
  90d219b

  Copy full SHA for 90d219b