Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC 0145] Doc-comments #145

Merged
merged 116 commits into from
Nov 29, 2023
Merged
Changes from 78 commits
Commits
Show all changes
116 commits
Select commit Hold shift + click to select a range
af461dd
init: rfc about docs-string format
hsjobeki Mar 29, 2023
dee60aa
init: rfc number
hsjobeki Mar 29, 2023
4508831
fix some major spelling issues
hsjobeki Mar 29, 2023
34bf50e
gramatical cleanup
hsjobeki Mar 29, 2023
130d9e5
gramatical cleanup
hsjobeki Mar 29, 2023
ab0aa26
fix: consistent naming: doc-string(s)
hsjobeki Mar 29, 2023
2b0dea2
Update rfcs/0145-doc-strings.md
hsjobeki Mar 29, 2023
a3ee89a
make statement more clear
hsjobeki Mar 29, 2023
e1a7475
add statement what a sections is
hsjobeki Mar 29, 2023
d7e0cf5
remove empty example
hsjobeki Mar 29, 2023
4d69893
Update rfcs/0145-doc-strings.md
hsjobeki Mar 30, 2023
b4a1297
add: more examples, explanations
hsjobeki Mar 30, 2023
f6bd84f
Update 0145-doc-strings.md
hsjobeki Mar 30, 2023
4d2329a
Update 0145-doc-strings.md
hsjobeki Mar 30, 2023
402f065
Update rfcs/0145-doc-strings.md
hsjobeki Mar 30, 2023
fa2cb38
Update 0145-doc-strings.md
hsjobeki Mar 31, 2023
2fdb3c2
Update rfcs/0145-doc-strings.md
hsjobeki Apr 1, 2023
805a8e1
Update rfcs/0145-doc-strings.md
hsjobeki Apr 1, 2023
c9d19a6
Update rfcs/0145-doc-strings.md
hsjobeki Apr 1, 2023
83ebf36
Merge branch 'NixOS:master' into feat/doc-strings
hsjobeki Apr 2, 2023
e677af5
Restructuring
hsjobeki Apr 2, 2023
84b29fb
Update 0145-doc-strings.md
hsjobeki Apr 2, 2023
d5e3083
fix some minor grammar mistakes
hsjobeki Apr 2, 2023
6fc5a41
Consolidate into one big table
hsjobeki Apr 4, 2023
d546b39
Update 0145-doc-strings.md
hsjobeki Apr 4, 2023
9f9c5d7
Extend references
hsjobeki Apr 4, 2023
29eea3e
Update 0145-doc-strings.md
hsjobeki Apr 4, 2023
1894149
Update 0145-doc-strings.md
hsjobeki Apr 4, 2023
b511aa1
Update 0145-doc-strings.md
hsjobeki Apr 4, 2023
a9e380b
Update 0145-doc-strings.md
hsjobeki Apr 5, 2023
9ac29d9
Update 0145-doc-strings.md
hsjobeki Apr 6, 2023
1b5e5ef
Update 0145-doc-strings.md
hsjobeki Apr 6, 2023
498b045
update
hsjobeki Apr 6, 2023
6d47a93
update
hsjobeki Apr 6, 2023
14dca53
update
hsjobeki Apr 6, 2023
fe8ab29
work feedback into it
hsjobeki Apr 6, 2023
967136c
Work feedback into document
hsjobeki Apr 6, 2023
b581941
point to type checking
hsjobeki Apr 6, 2023
1f5bf5e
Update rfcs/0145-doc-strings.md
hsjobeki Apr 6, 2023
c8e85f3
Update 0145-doc-strings.md
hsjobeki Apr 7, 2023
5da22b4
Add roberth's PR from 2017
hsjobeki Apr 8, 2023
434f8b4
Update rfcs/0145-doc-strings.md
hsjobeki Apr 8, 2023
1105ea3
Update rfcs/0145-doc-strings.md
hsjobeki Apr 8, 2023
cb7f9d6
Update rfcs/0145-doc-strings.md
hsjobeki Apr 8, 2023
e5397ee
Update 0145-doc-strings.md
hsjobeki Apr 8, 2023
403b8cd
Update 0145-doc-strings.md
hsjobeki Apr 9, 2023
f7b4fb4
Add multiline doc string draft
hsjobeki Apr 9, 2023
40a51a1
add: point to the concerns
hsjobeki Apr 12, 2023
254863e
add: motivation multiline comments
hsjobeki Apr 12, 2023
acb9815
Feedback from docs-team
hsjobeki Apr 14, 2023
86475de
Update 0145-doc-strings.md
hsjobeki Apr 17, 2023
1097607
Update 0145-doc-strings.md
hsjobeki Apr 17, 2023
72b1c80
Merge pull request #3 from hsjobeki/documentation-team-feedback
hsjobeki Apr 17, 2023
b570f1c
Update 0145-doc-strings.md
hsjobeki Apr 17, 2023
48477b1
Update 0145-doc-strings.md
hsjobeki Apr 17, 2023
3c1a8f7
clearify: doc comment reference logic
hsjobeki Apr 20, 2023
834f8d4
Update rfcs/0145-doc-strings.md
hsjobeki Apr 20, 2023
e693a28
Update rfcs/0145-doc-strings.md
hsjobeki Apr 29, 2023
fc92941
Update rfcs/0145-doc-strings.md
hsjobeki Apr 29, 2023
c30cb33
Update rfcs/0145-doc-strings.md
hsjobeki Apr 29, 2023
bf9cf3c
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
caa849a
clarify & add some more examples
hsjobeki Apr 30, 2023
fcc76be
Merge branch 'feat/doc-strings' of github.com:hsjobeki/rfcs into feat…
hsjobeki Apr 30, 2023
6790f9d
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
298955f
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
477c880
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
6d4a327
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
e094210
update nixdoc format according to current nixodc-maintainer
hsjobeki Apr 30, 2023
05c3c9d
Update rfcs/0145-doc-strings.md
hsjobeki Apr 30, 2023
6ad8480
Update 0145-doc-strings.md
hsjobeki Apr 30, 2023
321fbce
Update 0145-doc-strings.md
hsjobeki Apr 30, 2023
3066a3e
Update 0145-doc-strings.md
hsjobeki Apr 30, 2023
92919d7
Update 0145-doc-strings.md
hsjobeki Apr 30, 2023
36adf87
Update 0145-doc-strings.md
hsjobeki Apr 30, 2023
cd3cf33
Update rfcs/0145-doc-strings.md
hsjobeki May 1, 2023
65d33a6
work feedback from @asymmetric in
hsjobeki May 6, 2023
56f25ca
Add @sternenseemann as sheperd
hsjobeki May 12, 2023
be8fa44
Add sheperd team members
hsjobeki Jul 31, 2023
bb33f91
Apply suggestions from @asymmetric
hsjobeki Jul 31, 2023
63321c4
Rework: improves content for problem targeting and readablity
hsjobeki Jul 31, 2023
b4067a8
Merge branch 'NixOS:master' into feat/doc-strings
hsjobeki Sep 28, 2023
f146807
Clean up RFC according to meeting notes
hsjobeki Sep 28, 2023
4c8fc55
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
273ace0
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
ba8d6f5
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
5599344
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
b986270
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
b133e65
Update 0145-doc-strings.md
hsjobeki Sep 29, 2023
f415a11
Add non goal
hsjobeki Sep 29, 2023
6864009
remove unnecessary sentence
hsjobeki Oct 26, 2023
174040a
Code has interface
hsjobeki Oct 26, 2023
b6bea69
More specific outer format
hsjobeki Oct 26, 2023
70bca5e
Single format simplifies tooling.
hsjobeki Oct 26, 2023
72359a2
fix typo
hsjobeki Oct 26, 2023
00e76a7
Typo
hsjobeki Oct 27, 2023
d829157
Correct statement about old pr
hsjobeki Oct 27, 2023
1c1eacc
Dont overspecify whitespaces
hsjobeki Oct 27, 2023
74820d5
Update rfcs/0145-doc-strings.md
hsjobeki Oct 27, 2023
fedeadf
strictly follow rfc72
hsjobeki Oct 28, 2023
4ee5636
Attribute path leafs: add example
hsjobeki Oct 29, 2023
cc333bd
Update 0145-doc-strings.md
hsjobeki Oct 29, 2023
b26faa5
Update 0145-doc-strings.md
hsjobeki Oct 30, 2023
d6c2590
Specify documentable nodes. Not only expressions
hsjobeki Oct 31, 2023
fcc24cd
Update 0145-doc-strings.md
hsjobeki Oct 31, 2023
51f5bcc
typo: partial applications
hsjobeki Nov 3, 2023
1e3f041
feedback from comment
hsjobeki Nov 4, 2023
6471c42
Add migration example
hsjobeki Nov 8, 2023
e6870a0
Add link to codemod on migration example
hsjobeki Nov 9, 2023
9dcad4a
Add non goal: Styling of markdown
hsjobeki Nov 9, 2023
4fa538f
Call implementation comments
hsjobeki Nov 9, 2023
005e34f
Update: Mental model about arguments
hsjobeki Nov 9, 2023
6c74780
Move single line comments to future work
hsjobeki Nov 9, 2023
a9dad7b
Remove partial lambda example
hsjobeki Nov 9, 2023
2987912
fix typos
hsjobeki Nov 16, 2023
e4a6dd7
nix implementation is out of scope.
hsjobeki Nov 19, 2023
90d219b
Add occurence details about /**/ and /** */
hsjobeki Nov 20, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading