Skip to content

Commit

Permalink
Merge pull request #13 from jsr-core/fix-link
Browse files Browse the repository at this point in the history
docs: fix `@linkcode` URLs
  • Loading branch information
lambdalisue authored Aug 12, 2024
2 parents 815ff9e + 3ba48e9 commit 20b888b
Show file tree
Hide file tree
Showing 53 changed files with 150 additions and 150 deletions.
4 changes: 2 additions & 2 deletions async/chain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
* The chained iterable will yield the elements of the first iterable, then the
* elements of the second iterable, and so on.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/zip zip} to zip iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/chain chain} to chain iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/zip/~/zip zip} to zip iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/chain/~/chain chain} to chain iterables synchronously.
*
* @param iterables The iterables to chain.
* @returns The chained iterable.
Expand Down
4 changes: 2 additions & 2 deletions async/chunked.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
*
* The last chunk may have less than `size` elements.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/flatten flatten} to flatten the chunks.
* Use {@linkcode https://jsr.io/@core/iterutil/chunked chunked} to chunk iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/flatten/~/flatten flatten} to flatten the chunks.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/chunked/~/chunked chunked} to chunk iterables synchronously.
*
* @param iterable The iterable to chunk.
* @param size The size of each chunk.
Expand Down
6 changes: 3 additions & 3 deletions async/compact.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Removes all nullish (`null` or `undefined`) values from an iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/compress compress} to remove values based on an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to remove values based on a function.
* Use {@linkcode https://jsr.io/@core/iterutil/compact compact} to compact iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/compress/~/compress compress} to remove values based on an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to remove values based on a function.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/compact/~/compact compact} to compact iterables synchronously.
*
* @param iterable The iterable to compact.
* @returns The compacted iterable.
Expand Down
6 changes: 3 additions & 3 deletions async/compress.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
* If the input iterable is shorter than the selector iterable, the output will
* be truncated to the length of the input iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/compact compact} to remove nullish values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to remove values based on a function.
* Use {@linkcode https://jsr.io/@core/iterutil/compress compress} to compress iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/compact/~/compact compact} to remove nullish values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to remove values based on a function.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/compress/~/compress compress} to compress iterables synchronously.
*
* @param iterable The iterable to compress.
* @param selectors The selectors to use.
Expand Down
4 changes: 2 additions & 2 deletions async/cycle.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* Returns an infinite iterable that cycles through the given iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/take take} to limit the number of items of the cycled iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/cycle cycle} to cycle the iterable synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/take/~/take take} to limit the number of items of the cycled iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/cycle/~/cycle cycle} to cycle the iterable synchronously.
*
* @param iterable The iterable to cycle.
* @returns The cycled iterable.
Expand Down
6 changes: 3 additions & 3 deletions async/drop.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Drops the first `limit` items from the iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/drop-while dropWhile} to drop items while a condition is met.
* Use {@linkcode https://jsr.io/@core/iterutil/async/take take} to take a specific number of items from an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/drop drop} to drop items synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/drop-while/~/dropWhile dropWhile} to drop items while a condition is met.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/take/~/take take} to take a specific number of items from an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/drop/~/drop drop} to drop items synchronously.
*
* @param iterable The iterable to drop items from.
* @param limit The number of items to drop. It must be 0 or positive safe integer.
Expand Down
6 changes: 3 additions & 3 deletions async/drop_while.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* The first element that does not match the predicate is included in the output.
* If the predicate never returns false, the output will be an empty iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/drop drop} to drop a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/async/take take} to take a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/drop-while dropWhile} to drop elements synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/drop/~/drop drop} to drop a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/take/~/take take} to take a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/drop-while/~/dropWhile dropWhile} to drop elements synchronously.
*
* @param iterable The iterable to drop elements from.
* @param fn The predicate function to drop elements with.
Expand Down
6 changes: 3 additions & 3 deletions async/enumerate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* If `start` is not provided, it defaults to `0`.
* If `step` is not provided, it defaults to `1`.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/zip zip} to zip iterable with other iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/async/count count} to generate an infinite sequence of numbers.
* Use {@linkcode https://jsr.io/@core/iterutil/enumerate enumerate} to enumerate synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/zip/~/zip zip} to zip iterable with other iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/count/~/count count} to generate an infinite sequence of numbers.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/enumerate/~/enumerate enumerate} to enumerate synchronously.
*
* @param iterable The iterable to enumerate.
* @param start The starting index.
Expand Down
4 changes: 2 additions & 2 deletions async/every.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
*
* If the iterable is empty, this function returns true.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/some some} to check if any element satisfies the function.
* Use {@linkcode https://jsr.io/@core/iterutil/every every} to check synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/some/~/some some} to check if any element satisfies the function.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/every/~/every every} to check synchronously.
*
* @param iterable The iterable to test.
* @param fn The function to test with.
Expand Down
10 changes: 5 additions & 5 deletions async/filter.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/**
* Filters an iterable based on a function.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/compact compact} to remove nullish values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/compress compress} to remove values based on an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/async/map map} to transform the values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/reduce reduce} to reduce the values.
* Use {@linkcode https://jsr.io/@core/iterutil/filter filter} to filter synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/compact/~/compact compact} to remove nullish values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/compress/~/compress compress} to remove values based on an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/map/~/map map} to transform the values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/reduce/~/reduce reduce} to reduce the values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/filter/~/filter filter} to filter synchronously.
*
* @params iterable The iterable to filter.
* @params fn The function to filter with.
Expand Down
8 changes: 4 additions & 4 deletions async/find.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
* Returns the first element in the iterable that satisfies the provided
* testing function. Otherwise, undefined is returned.
*
* Use {@link https://jsr.io/@core/iterutil/async/first first} to get the first element.
* Use {@link https://jsr.io/@core/iterutil/async/last last} to get the last element.
* Use {@link https://jsr.io/@core/iterutil/async/filter filter} to filter elements.
* Use {@link https://jsr.io/@core/iterutil/find find} to find elements synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/first/~/first first} to get the first element.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/last/~/last last} to get the last element.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter elements.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/find/~/find find} to find elements synchronously.
*
* @param iterable The iterable to search.
* @param fn The function to test with.
Expand Down
6 changes: 3 additions & 3 deletions async/first.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Returns the first element of an iterable. If the iterable is empty, returns `undefined`.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/last last} to get the last element of an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/async/find find} to get the first element that matches a predicate.
* Use {@linkcode https://jsr.io/@core/iterutil/first first} to get the first element synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/last/~/last last} to get the last element of an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/find/~/find find} to get the first element that matches a predicate.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/first/~/first first} to get the first element synchronously.
*
* @param iterable The iterable to get the first element from.
* @returns The first element of the iterable, or `undefined` if the iterable is empty.
Expand Down
8 changes: 4 additions & 4 deletions async/flat_map.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* Maps each value in an iterable to an iterable, then flattens the result.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/map map} to map values to iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/flatten flatten} to flatten an iterable of iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/flat-map flatMap} to flat map an iterable synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/map/~/map map} to map values to iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/flatten/~/flatten flatten} to flatten an iterable of iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/flat-map/~/flatMap flatMap} to flat map an iterable synchronously.
*
* @param iterable The iterable to flat map.
* @param fn The function to map with.
Expand Down
8 changes: 4 additions & 4 deletions async/flatten.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* Flattens an iterable of iterables into a single iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/map map} to map values to iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/flat-map flatMap} to flat map an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/flatten flatten} to flatten an iterable of iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/map/~/map map} to map values to iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/flat-map/~/flatMap flatMap} to flat map an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/flatten/~/flatten flatten} to flatten an iterable of iterables synchronously.
*
* @param iterable The iterable to flatten.
* @returns The flattened iterable.
Expand Down
6 changes: 3 additions & 3 deletions async/for_each.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Calls a function for each value in an iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/map map} to transform values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/for-each forEach} to iterate synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/map/~/map map} to transform values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/for-each/~/forEach forEach} to iterate synchronously.
*
* @param iterable The iterable to iterate over.
* @param fn The function to call for each value.
Expand Down
4 changes: 2 additions & 2 deletions async/iter.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* Converts an iterable to an iterable iterator.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/to-async-iterable toAsyncIterable} for converting an async iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/iter iter} for `IterableIterator`.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/to-async-iterable/~/toAsyncIterable toAsyncIterable} for converting an async iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/iter/~/iter iter} for `IterableIterator`.
*
* @param iterable The iterable to convert.
* @returns The iterable iterator.
Expand Down
6 changes: 3 additions & 3 deletions async/last.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Returns the last element of an iterable.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/first first} to get the first element.
* Use {@linkcode https://jsr.io/@core/iterutil/async/find find} to find an element.
* Use {@linkcode https://jsr.io/@core/iterutil/last last} to get the last element synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/first/~/first first} to get the first element.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/find/~/find find} to find an element.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/last/~/last last} to get the last element synchronously.
*
* @param iterable The iterable to get the last element of.
* @returns The last element of the iterable, or `undefined` if the iterable is empty.
Expand Down
10 changes: 5 additions & 5 deletions async/map.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/**
* Maps an iterable with a function.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/async/for-each forEach} to call a function for each value.
* Use {@linkcode https://jsr.io/@core/iterutil/async/flat-map flatMap} to flat map an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/async/flatten flatten} to flatten an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/map map} to map synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter values.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/for-each/~/forEach forEach} to call a function for each value.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/flat-map/~/flatMap flatMap} to flat map an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/flatten/~/flatten flatten} to flatten an iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/map/~/map map} to map synchronously.
*
* @param iterable The iterable to map.
* @param fn The function to map with.
Expand Down
2 changes: 1 addition & 1 deletion async/pairwise.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*
* When the input iterable has a finite number of items `n`, the output iterable will have `n - 1` items.
*
* Use {@linkcode https://jsr.io/@core/iterutil/pairwise pairwise} to pair elements from an iterable synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/pairwise/~/pairwise pairwise} to pair elements from an iterable synchronously.
*
* @param iterable The iterable to pair elements from.
* @returns The paired iterable.
Expand Down
2 changes: 1 addition & 1 deletion async/partition.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Partitions an iterable into two arrays based on a selector function.
*
* Use {@linkcode https://jsr.io/@core/iterutil/partition partition} to partition synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/partition/~/partition partition} to partition synchronously.
*
* @param iterable The iterable to partition.
* @param selector The function to partition with.
Expand Down
6 changes: 3 additions & 3 deletions async/reduce.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
*
* The first element is used as the initial value.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/map map} to transform values of the iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/async/filter filter} to filter values of the iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/reduce reduce} to reduce an iterable synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/map/~/map map} to transform values of the iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/filter/~/filter filter} to filter values of the iterable.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/reduce/~/reduce reduce} to reduce an iterable synchronously.
*
* @param iterable The iterable to reduce.
* @param fn The function to reduce with.
Expand Down
4 changes: 2 additions & 2 deletions async/some.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
*
* If the iterable is empty, this function returns false.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/every every} to check if every
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/every/~/every every} to check if every
* element satisfies the provided function.
* Use {@linkcode https://jsr.io/@core/iterutil/some some} to check synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/some/~/some some} to check synchronously.
*
* @param iterable The iterable to check.
* @param fn The function to check with.
Expand Down
6 changes: 3 additions & 3 deletions async/take.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
*
* Note that it will stop consuming the iterable once `limit` items are taken.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/take-while takeWhile} to take items while the predicate returns true.
* Use {@linkcode https://jsr.io/@core/iterutil/async/drop drop} to drop items from the beginning.
* Use {@linkcode https://jsr.io/@core/iterutil/take take} to take items synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/take-while/~/takeWhile takeWhile} to take items while the predicate returns true.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/drop/~/drop drop} to drop items from the beginning.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/take/~/take take} to take items synchronously.
*
* @param iterable The iterable to take items from.
* @param limit The number of items to take. It must be 0 or positive safe integer.
Expand Down
6 changes: 3 additions & 3 deletions async/take_while.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* Takes elements from the iterable while the predicate is true.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/take take} to take a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/async/drop drop} to drop a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/take-while take} to take elements synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/take/~/take take} to take a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/drop/~/drop drop} to drop a specific number of elements.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/take-while/~/take take} to take elements synchronously.
*
* @param iterable The iterable to take elements from.
* @param fn The predicate to take elements with.
Expand Down
6 changes: 3 additions & 3 deletions async/zip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
* If the input iterables have different lengths, the resulting iterable will stop when the shortest input iterable is exhausted.
* The remaining elements from the longer input iterables will be ignored.
*
* Use {@linkcode https://jsr.io/@core/iterutil/async/chain chain} to chain iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/async/enumerate enumerate} to zip with indices.
* Use {@linkcode https://jsr.io/@core/iterutil/zip zip} to zip iterables synchronously.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/chain/~/chain chain} to chain iterables.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/async/enumerate/~/enumerate enumerate} to zip with indices.
* Use {@linkcode https://jsr.io/@core/iterutil/doc/zip/~/zip zip} to zip iterables synchronously.
*
* @param iterables The iterables to zip.
* @returns The zipped iterable.
Expand Down
Loading

0 comments on commit 20b888b

Please sign in to comment.