|
00:03
librasteve_ left
00:27
kjp left
00:28
kjp joined
00:30
kjp left
00:31
kjp joined
01:58
kjp left
01:59
kjp joined
02:42
arkiuat left
02:48
arkiuat joined
02:53
arkiuat left
02:54
arkiuat joined
02:59
arkiuat left
03:08
arkiuat joined
05:35
arkiuat left
05:37
arkiuat joined
05:45
arkiuat left
05:59
arkiuat joined
06:03
arkiuat left
06:33
arkiuat joined
06:38
arkiuat left
07:09
arkiuat joined
07:13
arkiuat left
07:33
arkiuat joined
07:35
librasteve_ joined
07:38
arkiuat left
07:51
arkiuat joined
07:56
arkiuat left
08:18
arkiuat joined
08:23
arkiuat left
08:50
arkiuat joined
08:54
arkiuat left
09:19
arkiuat joined
09:24
arkiuat left
09:52
arkiuat joined
09:54
finanalyst joined
09:57
arkiuat left
10:20
arkiuat joined
10:25
arkiuat left
10:52
arkiuat joined
10:56
arkiuat left
11:20
finanalyst left
11:21
arkiuat joined
11:26
arkiuat left
11:55
arkiuat joined
12:00
arkiuat left
12:22
arkiuat joined
12:26
arkiuat left
12:44
arkiuat joined
|
|||
| arkiuat | It just occurred to me that it's a pretty important general principle, when documenting a newly implemented feature, to focus the documentation on describing the behavior required in the roast tests and not just what the documenter found out by experimenting with the feature as currently implemented | 13:00 | |
| Do we state this anywhere in documentation guidelines? | |||
| Geth | doc: arkiuat++ created pull request #4647: add method .multi-invocant to class Parameter |
14:14 | |
| arkiuat | ds7832, I totally agree with you about adding slurpies to the discussion at the beginning of language/signatures | 14:24 | |
| ds7832 | perfect! | 14:25 | |
| arkiuat | tbrowder, your github.com/tbrowder/tidbits/blob/m...ing-PRs.md is very helpful. Thank you! I've been using it, but it might be good to add to run the util/test-modified.sh script right before committing | 14:30 | |
| I always forget to do that until right after I commit on my local fork, after which I think it just says "nothing to test" | 14:31 | ||
| ds7832 | Another roast relevant to ;; is this one: # github.com/rakudo/rakudo/issues/3611 | 14:36 | |
| uh, this one github.com/Raku/roast/blob/b822369...ignature.t | 14:37 | ||
| librasteve_ | tellable6: arkuiat Hello! | 14:41 | |
| .seen jnthn | 14:42 | ||
| m: say 0.1+0.2 | 14:43 | ||
| arkiuat | [Coke] sorry about the whitespace. This is the second time I forgot to run util/test-modified.sh until after the local commit, but I'm trying not to make a habit of it! | 14:46 | |
| thanks librasteve | |||
| tbrowder | arkiuat: thanks, glad you found it useful. please submit your suggestion as a PR. and i'm sure it could use some more love based on my recent bad record of PRs for Raku doc PRs! | 14:58 | |
| ds7832 | arkiuat: I've just found something on what's behind the title "Long names" of the section on ;; | 15:04 | |
| github.com/Raku/roast/blob/master/...ed-mixin.t | |||
| Ctrl+f for ;; and then the long comment right above that | |||
|
15:12
arkiuat left
15:24
arkiuat joined
15:28
arkiuat left
15:43
arkiuat joined
|
|||
| librasteve_ | hmm seems to me that Long Name is a confusing header name here - it’s an implementation detail and doesn’t need to be part of the docs | 15:43 | |
|
15:48
arkiuat left
15:50
arkiuat joined
|
|||
| ds7832 | Yes, I definitely think it should be changed. Perhaps "Disregarding parameters in multi-dispatch" | 15:53 | |
| So the rakudoc code for the title would become something like | 16:01 | ||
| =head1 X<Disregarding parameters for multi-dispatch|Language,Long names;Syntax,;;> | |||
| but I bet that the ;; at the end will be interpreted incorrectly as rakudoc syntax, right? github.com/Raku/doc/blob/main/writ...NDEXING.md | |||
| (unfortunately I haven't gotten local compilation of the docs system set up yet) | 16:03 | ||
| arkiuat | tbrowder, I'll submit that PR as soon as I've actually used util/test-modified.sh myself for the first time | 16:33 | |
| or shortly thereafter, anyway | |||
| librasteve_ | ds7832: how about “Disregarding Parameters” ;-) | 16:34 | |
| ds7832 | oh, that would solve all problems at once! | 16:35 | |
|
18:35
librasteve_ left
18:43
arkiuat left
18:50
arkiuat joined
18:54
arkiuat left
19:07
arkiuat joined
19:12
arkiuat left
19:31
arkiuat joined
|
|||
| tbrowder | arkiuat: i think that "tidbits" needs a better name. i was reluctant to pick a better name because of possible GitHub copyright issues. maybe make it a raku module? | 20:19 | |
| [Coke] | arkiuat: Might be worth mentioning in writing-docs if you want to submit a note | 20:35 | |
| arkiuat: note that PRs are now going through CI and so most of those tests are run when you submit the PR | |||
| e.g. github.com/Raku/doc/actions/runs/1...76?pr=4647 | 20:36 | ||
| So just make sure your checks pass. It's OK if the PR goes in and you then fix it right away | |||
| Geth | doc: schultzdavid++ created pull request #4648: In signatures.rakudoc: Complete overhaul regarding double semicolon (;;) for controlling signature precedence |
21:33 | |
| doc/main: 6a8d9dedf5 | schultzdavid++ (committed using GitHub Web editor) | doc/Language/signatures.rakudoc In signatures.rakudoc: Complete overhaul regarding double semicolon (;;) for controlling signature precedence (#4648) * Complete overhaul of section on double semicolon (;;) parameter separator in file Language/signatures.rakudoc * fix semicolons * correct backtick to rakudoc syntax for code |
21:57 | ||
| doc/main: 2862fe66e6 | (Eric Forste)++ (committed using GitHub Web editor) | doc/Type/Parameter.rakudoc add method .multi-invocant (#4647) |
21:58 | ||
| doc/main: caf912c4be | (Will Coleda)++ | doc/Type/Parameter.rakudoc whitespace |
22:00 | ||
| doc/main: c653b9c211 | (Will Coleda)++ | doc/Language/signatures.rakudoc fix a link to a type; |
|||
| ds7832 | Coke: Thanks for merging! | 22:01 | |
| (I hope all the links I added work) | 22:03 | ||
| [Coke] | There's a test for links. | 22:07 | |
| rakudoc-l - set NETWORK_TESTING=1 to test remote links | |||
| That one isn't run by default on PRs | |||
| ds7832 | Ah, it's actually only internal ones | 22:08 | |
| [Coke] | Running a full rakudoc-l check (w/out network) now to heck | ||
| ds7832 | very cool! | ||
| [Coke] | ds7832: gist.github.com/coke/85455a5e391c3...188c0dd272 | 22:42 | |
| only a few failures if you want to tackle them... though some may be "hey, this entire doc page needs to be created" | |||
| there's a summary at the bottom, otherwise scan for 'not ok' | |||
| (looks like it's all older errors missing Exceptions | 22:43 | ||
| Also see: | |||
| ... can't find it- used to be a page showing all the 404s live on the site, also | 22:44 | ||
| might have been lost in the last site cleanup | 22:45 | ||
| aha, google had it: docs.raku.org/error-report | |||
| That one is smarter because it builds the site so can check constructed pages. | |||
| ds7832 | Thanks | 22:51 | |
| looks like all errors in signatures.rakudoc were there before, good. | 22:52 | ||
| I have more edits in my mind for the first two sections of that file, which I'll likely do tomorrow (Berlin time) | 22:53 | ||
| but I've bookmarked these two links for potential future work | 22:54 | ||
| [Coke] | Awesome. thanks for all the edits! | 23:16 | |