Skip to content

Commit

Permalink
Remove unnecessary docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
ori88c committed Aug 13, 2024
1 parent 1254ca9 commit 1c61238
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 16 deletions.
7 changes: 2 additions & 5 deletions dist/data-oriented-slim-queue.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ export declare const DEFAULT_SLIM_QUEUE_CAPACITY_INCREMENT_FACTOR = 1.5;
/**
* SlimQueue
*
* The `SlimQueue` class implements an in-memory queue with a basic API, targeting pure use cases like
* task queues, breadth-first search (BFS), and similar scenarios. It intentionally excludes linear
* operations such as iteration and splicing, often found in more feature-rich queue variants, as these
* are considered over-engineering for pure queue use cases. Instead, these complex operations can be
* more effectively achieved through the composition of simpler building blocks.
* The `SlimQueue` class implements an in-memory queue with a basic API, targeting pure FIFO use cases
* like task queues, breadth-first search (BFS), and similar scenarios.
*
* ### Data-Oriented Design
* This implementation follows the principles of Data-Oriented Design (DOD), optimizing memory layout and
Expand Down
7 changes: 2 additions & 5 deletions dist/data-oriented-slim-queue.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/data-oriented-slim-queue.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 2 additions & 5 deletions src/data-oriented-slim-queue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,8 @@ const MAX_ALLOWED_CAPACITY_INCREMENT_FACTOR = 2;
/**
* SlimQueue
*
* The `SlimQueue` class implements an in-memory queue with a basic API, targeting pure use cases like
* task queues, breadth-first search (BFS), and similar scenarios. It intentionally excludes linear
* operations such as iteration and splicing, often found in more feature-rich queue variants, as these
* are considered over-engineering for pure queue use cases. Instead, these complex operations can be
* more effectively achieved through the composition of simpler building blocks.
* The `SlimQueue` class implements an in-memory queue with a basic API, targeting pure FIFO use cases
* like task queues, breadth-first search (BFS), and similar scenarios.
*
* ### Data-Oriented Design
* This implementation follows the principles of Data-Oriented Design (DOD), optimizing memory layout and
Expand Down

0 comments on commit 1c61238

Please sign in to comment.