-
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: create markdown docs and github wiki #10
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
Open
nberlette
wants to merge
25
commits into
main
Choose a base branch
from
docs/wiki
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR centralizes documentation updates and code cleanup by
- Standardizing
@seeURLs across source files to remove version-specific paths - Removing license headers from test files for brevity
- Refactoring core modules (
string_iterator.ts,function.ts) and generating comprehensive markdown docs underdocs/
Reviewed Changes
Copilot reviewed 296 out of 347 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/string_iterator.ts | Unified StringIterator interface, updated imports and JSDoc |
| src/function.ts | Introduced FunctionLike types and refined isFunction API |
| docs/writable-stream.md | New generated docs for stream predicates |
| docs/string-iterator.md | New generated docs for string iterator predicate |
Comments suppressed due to low confidence (4)
src/function.ts:9
- The JSDoc summary is incomplete (
This). Please provide a concise description of the module or function here to improve clarity.
* This
docs/writable-stream.md:31
- There's a stray
a;on this line that appears to be a typo. Please remove it to clean up the example.
a;
docs/string-iterator.md:38
- The example uses
iteratorbut the variable is declared asiter. Update the example toisStringIterator(iter)to match the code.
console.log(isStringIterator(iterator)); // true
src/string_iterator.ts:32
- The
IteratorObjecttype is referenced here but not imported. Please add an import forIteratorObject(e.g.import type { IteratorObject } from "./iterator.ts";) to avoid a missing symbol error.
extends IteratorObject<T> {
Happy 32nd birthday to me!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #9
Changes