Divy Srivastava
16fa0c8220
docs(json): lint @std/json docs ( #4798 )
...
* docs(json): lint `json/` docs
* Fix example
* skip eval of some examples
* fixes
* remove tmp.jsonl
* add example reading from a file
* add same example to constructor
* tweak
---------
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-06-18 10:10:57 +00:00
Yoshiya Hinosawa
635e062330
docs(testing): improve the docs of @std/testing ( #5033 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-06-17 11:31:31 +09:00
Asher Gomez
f7ae2aa8d5
docs(msgpack): complete documentation ( #5029 )
2024-06-12 15:49:23 +12:00
Asher Gomez
de68967e8d
docs(regexp): complete documentation ( #5023 )
...
* docs(regexp): complete documentation
* clean
* tweaks
2024-06-11 19:06:12 +12:00
Yoshiya Hinosawa
ec73b76d91
docs(ini): improve ini docs ( #5020 )
2024-06-11 16:05:04 +09:00
Asher Gomez
35c240eeed
docs(fs): improve documentation ( #4788 )
2024-06-07 15:54:50 +12:00
Asher Gomez
94bb952729
docs(net): complete documentation ( #4982 )
2024-06-07 15:54:15 +12:00
Asher Gomez
b8d94177a5
docs(url): complete documentation ( #4965 )
...
* docs(url): complete documentation
* suggestions
2024-06-05 21:16:52 +00:00
Asher Gomez
31b906db99
chore: ensure code examples use assertions in Doc Linter ( #4911 )
2024-06-03 14:10:27 +10:00
Yoshiya Hinosawa
3db62b0017
docs(csv): improve API docs ( #4920 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-06-03 12:32:09 +09:00
Yoshiya Hinosawa
388800f301
docs(path): improve API docs ( #4900 )
...
Co-authored-by: Nathan Whitaker <nathan@deno.com>
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-06-02 11:46:36 +09:00
Yoshiya Hinosawa
e9bcddb491
chore: use --no-lock in doc snippet eval ( #4918 )
2024-05-31 18:37:53 +09:00
Yoshiya Hinosawa
f94f8f3580
docs(crypto): improve docs ( #4884 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-31 11:39:47 +09:00
Asher Gomez
79d6a70729
docs(assert,cli,data-structures,expect,fmt,front-matter,html,http,jsonc,semver,streams,text,toml,webgpu): add snippet checks in module, function and class docs to doc checker ( #4855 )
...
* chore: add snippet checks to module docs
* fix
* work
* tweak
2024-05-31 12:01:46 +10:00
Divy Srivastava
079e40296c
docs(toml): lint @std/toml docs ( #4799 )
...
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-30 13:08:02 +09:00
Yoshiya Hinosawa
47c38498eb
docs(assert): improve docs ( #4876 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-30 11:38:16 +09:00
Yoshiya Hinosawa
595d812ea3
docs(html): improve API docs ( #4878 )
2024-05-29 18:15:48 +09:00
Yoshiya Hinosawa
1e194f746b
chore: don't require @returns tag when return type is type assertion ( #4873 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-29 16:33:37 +09:00
Yoshiya Hinosawa
0b95598ec1
chore: show the total number of doc errors ( #4871 )
2024-05-29 15:21:43 +09:00
Marvin Hagemeister
999e5e7a97
docs(uuid): update module docs ( #4790 )
2024-05-29 15:47:42 +10:00
Asher Gomez
ab6d747f9c
chore: implement custom resolver for doc() ( #4866 )
2024-05-29 11:55:37 +09:00
Yoshiya Hinosawa
1eaee146c3
docs(fmt): improve API docs ( #4829 )
...
Co-authored-by: Luca Casonato <lucacasonato@yahoo.com>
2024-05-28 15:14:34 +09:00
Yusuke Tanaka
9c3c53e65b
docs(streams): improve docs for stabilization ( #4852 )
...
This commit improves docs of the streams module.
Towards #3764
---------
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-05-27 18:27:40 -07:00
Yusuke Tanaka
d13ef17a5d
docs(front-matter): improve docs for stabilization ( #4789 )
...
This commit improves docs of the front-matter module.
Specifically, the following things are done:
- Use `@example` where appropriate to render the examples more beautifully
- Split the big example attached to `createExtractor` function into smaller pieces so that each one has minimal yet meaningful example
- Add `@returns` to the `test` function
- Deduplicate `Format` type definition
- Add a brief description to `Format` type
Towards #3764
---------
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-27 18:14:52 -07:00
Yoshiya Hinosawa
083b63f428
docs(semver): improve docs ( #4846 )
...
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-27 19:03:20 +09:00
Yoshiya Hinosawa
b9dbcb774d
chore: reorder check-doc entries ( #4857 )
2024-05-27 18:19:27 +09:00
Yoshiya Hinosawa
826344cd29
docs(data-structures): enables doc lint of data-structures ( #4847 )
2024-05-27 14:30:26 +09:00
Nathan Whitaker
472f370813
docs(encoding): Cleanup and fix doc lints ( #4838 )
...
* Polish varint encoding docs
* Use assertions in examples
* Fix incorrect example
* Fix doc lints
* Add encoding to doc lint entrypoints
* Fmt
---------
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-05-23 19:23:24 -07:00
David Sherret
5a6e99cc6e
docs(text): pass docs check ( #4837 )
2024-05-23 13:01:10 -04:00
David Sherret
c0d75322c7
docs(cli): make check_docs pass ( #4815 )
2024-05-23 12:53:13 -04:00
Satya Rohith
caac76fd34
docs(expect): document methods and add examples ( #4836 )
2024-05-23 16:50:11 +05:30
Leo Kettmeir
a3c99863f5
docs(http): improve docs for stabilization ( #4813 )
...
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-05-22 12:09:08 -07:00
David Sherret
d7424a2278
chore: improve check_docs.ts ( #4834 )
2024-05-22 11:58:40 -04:00
Luca Casonato
1a2f721d41
docs(ulid): finish documentation ( #4825 )
...
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-05-22 15:42:59 +02:00
Igor Zinkovsky
0248c18bfd
fix: complete docs for std/jsonc ( #4814 )
2024-05-22 06:03:58 +00:00
Asher Gomez
67ca078107
chore: add @example title check to doc checker ( #4823 )
...
* chore: add `@example` title check to doc checker
* fix
2024-05-22 15:08:36 +10:00
Leo Kettmeir
e3f63dc2ef
docs(async): improve docs for stabilization ( #4803 )
2024-05-21 17:40:43 -07:00
Leo Kettmeir
0ef767f52a
docs(webgpu): improve docs for stabilization ( #4811 )
2024-05-21 10:33:10 -07:00
Luca Casonato
006b96a586
ci: handle classes in check_docs.ts ( #4800 )
2024-05-21 16:09:42 +02:00
Asher Gomez
8fc19d95c7
chore: support no-eval code snippet directive ( #4791 )
2024-05-21 20:12:55 +10:00
Asher Gomez
16162ebcda
chore: improve doc checker ( #4782 )
...
* chore: improve doc checker
* tweaks
* tweaks
2024-05-21 15:34:08 +10:00
Asher Gomez
e07a1e6a87
docs(collections,internal,media-types): use @typeParam tag instead of @template ( #4772 )
2024-05-20 17:34:47 +10:00
Asher Gomez
17d7fffccc
docs(internal): cleanups and documentation improvements ( #4706 )
...
* feat(internal): `internal@1.0.0`
* work
* revert
* fix
* fix
2024-05-15 09:57:20 +02:00
Asher Gomez
1271a7f392
docs(media-types): polish documentation ( #4731 )
2024-05-15 16:33:05 +10:00
Asher Gomez
b32ab88b40
chore: update deno_doc ( #4726 )
2024-05-15 05:36:08 +10:00
Asher Gomez
a079dd3fed
docs(bytes,collections): fix doc checker and documentation ( #4691 )
...
docs(bytes,collection): fix doc checker and documentation
2024-05-08 16:18:26 +10:00
Asher Gomez
5e99c21210
docs(collections): complete documentation ( #4664 )
...
* docs(collections): complete documentation
* work
* work
* work
* work
* fix
* fixes
* fixes
* fixes
* fixes
* tweak
2024-05-06 16:51:20 +09:00
Asher Gomez
4bdefc105c
chore: run @example JSDoc code snippets ( #4669 )
...
* chore: run `@example` JSDoc code snippets
* async-ify
* work
* fix
* works
* fix
* tweak
2024-05-06 13:28:15 +10:00
Asher Gomez
b884c7ce73
chore: add @template JSDoc tag check ( #4667 )
2024-05-02 17:47:00 +10:00
Yoshiya Hinosawa
77996a9eb1
chore: update check_deprecation.ts ( #4657 )
2024-04-30 08:37:05 +09:00
Asher Gomez
ac5723de73
chore: JSDoc checker ( #4618 )
...
* chore: JSDoc checker
* work
* fix
2024-04-22 07:07:34 +00:00
