Skip to content

Conversation

@nberlette
Copy link
Owner

Closes #9

Changes

  • config: add Dockerfile
  • config: add devcontainer.json
  • chore: update copyrights. happy cinco de mayo!
  • docs(wiki): create github wiki submodule
  • chore: update wiki module
  • docs: add generated markdown docs
  • chore(docs): add nojekyll and gitignore files

Copilot AI review requested due to automatic review settings June 27, 2025 23:43
@nberlette nberlette added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 27, 2025
@nberlette nberlette self-assigned this Jun 27, 2025
@nberlette nberlette added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 27, 2025
Copy link

Copilot AI left a 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 @see URLs 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 under docs/

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 iterator but the variable is declared as iter. Update the example to isStringIterator(iter) to match the code.
console.log(isStringIterator(iterator)); // true

src/string_iterator.ts:32

  • The IteratorObject type is referenced here but not imported. Please add an import for IteratorObject (e.g. import type { IteratorObject } from "./iterator.ts";) to avoid a missing symbol error.
  extends IteratorObject<T> {

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create docs and wiki

2 participants