Commit Graph

70 Commits

Author SHA1 Message Date
Asher Gomez
b76ae272ae
BREAKING(streams/unstable): move to-lines module to unstable-to-lines (#5950) 2024-09-12 04:04:21 +00:00
Asher Gomez
4f1826d906
BREAKING(html/unstable): move is-valid-custom-element-name module to unstable-is-valid-custom-element-name (#5948)
* BREAKING(html/unstable): move `is-valid-custom-element-name` module to `unstable-is-valid-custom-element-name`

* fix
2024-09-12 13:02:20 +09:00
Yoshiya Hinosawa
e564069936
chore: lint docs of unstable paths (#5940) 2024-09-12 12:59:12 +09:00
Asher Gomez
fb0f40c302
BREAKING(data-structures/unstable): move bidirectional-map module to unstable-bidirectional-map (#5947)
BREAKING(data-structures): move `bidirectional-map` module to `unstable-bidirectional-map`
2024-09-12 12:58:23 +09:00
Asher Gomez
10aa1e739c
BREAKING(cli/unstable): move spinner module to unstable-spinner (#5946) 2024-09-12 12:52:06 +09:00
Asher Gomez
fc0f55c00c
BREAKING(url): remove @std/url (#5931) 2024-09-10 18:22:37 +09:00
lionel-rowe
149839b60c
feat(random/unstable): basic randomization functions (#5626)
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-09-05 14:17:10 +09:00
Asher Gomez
b05acd6570
feat(tar/unstable): @std/tar (#5905)
* feat(tar/unstable): `@std/tar`

* fix

* edit
2024-09-04 18:28:07 +10:00
Asher Gomez
b0708f49aa
chore: fix lint:docs task concurrency (#5756) 2024-08-22 13:10:17 +09:00
Asher Gomez
d6fde648e2
docs(archive): complete documentation (#5636)
* docs(archive): complete documentation

* work

* work

* work

* work

* fixes
2024-08-20 17:13:54 +10:00
Yusuke Tanaka
43f2a2dffd
chore: support expect-error directive in code snippets evaluator (#5688)
This commit adds support for `expect-error` directive in code snippets
evaluator, which allows example snippets to have ones that are expected to fail
either at compile time or runtime.
2024-08-16 02:58:01 -07:00
lionel-rowe
0c64f32cc3
feat(cache/unstable): add memoize() and LruCache (#4725)
Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-08-09 01:12:24 +09:00
Yoshiya Hinosawa
d93b33aff8
docs(io): document std/io (#5656)
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-08-08 23:20:43 +09:00
Asher Gomez
81e49f659a
chore: remove requirement for @examples in constructors (#5485) 2024-07-19 13:07:02 +09:00
Asher Gomez
ad1dad6ce6
docs(cli,csv,datetime,fmt,fs,http,ini,semver,testing): assert optional properties on types/interfaces have @default tag (#4933)
* docs: assert optional properties on types/interfaces have `@default` tag

* work

* work

* work

* work

* work

* work

* fix

* fix

* Update fs/expand_glob.ts

* cleanups

* cleanups

---------

Co-authored-by: Yoshiya Hinosawa <stibium121@gmail.com>
2024-07-11 09:21:37 +00:00
Asher Gomez
5f2b0f59b6
chore: allow lint:docs task to resolve root modules (#5198)
* chore: allow `lint:docs` task to resolve root modules

* fixes

* Revert "fixes"

This reverts commit b18f41c59c.
2024-06-30 18:27:29 +10:00
Yoshiya Hinosawa
2ad437d04f
BREAKING(yaml): make Schema and Type private and stop supporting user-defined schemas (#5175)
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-06-28 19:28:55 +09:00
Yoshiya Hinosawa
9411d0957e
docs(yaml): improve yaml document (#5127)
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
2024-06-25 15:01:58 +09:00
Yoshiya Hinosawa
21e8ece519
docs(dotenv): improve dotenv docs (#5095) 2024-06-21 13:21:26 +09:00
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