Simplified readme

caph1993 · Mar 20, 2024 · 2fc7ec0 · 2fc7ec0
1 parent e28db34
commit 2fc7ec0
Show file tree

Hide file tree

Showing 157 changed files with 328 additions and 295 deletions.
diff --git a/dist/docs-index.d.ts b/dist/docs-index.d.ts
@@ -1,7 +1,8 @@
 /**
  * @module ndarray-js
  * @description
- * # Welcome to the documentation of ndarray-js
+ * <style>h1 a code{ font-size: 200%; }</style>
+ * # Welcome to the documentation of `ndarray-js`
  * ndarray-js is a reimplementation of numpy for javascript that aims to make the coding experience as similar to numpy as possible.
  * ## API Index
  *  - Global namespace: {@link np}

diff --git a/dist/docs-index.d.ts.map b/dist/docs-index.d.ts.map
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/modules/constructors.d.ts b/dist/modules/constructors.d.ts
@@ -1,7 +1,13 @@
 import NDArray from '../NDArray';
-export declare function empty(shape: any, dtype?: import('../NDArray').DType): NDArray;
-export declare function zeros(shape: any, dtype?: import('../NDArray').DType): NDArray;
-export declare function ones(shape: any, dtype?: import('../NDArray').DType): NDArray;
+/**
+ * Creates a new array with the specified shape and type, without initializing entries.
+ */
+export declare function empty(shape: number[], dtype?: import('../NDArray').DType): NDArray;
+/**
+ * Creates a new array of zeros with the specified shape and dtype.
+ */
+export declare function zeros(shape: number[], dtype?: import('../NDArray').DType): NDArray;
+export declare function ones(shape: number[], dtype?: import('../NDArray').DType): NDArray;
 export declare function arange(arg0: any, arg1?: any): NDArray;
 export declare function linspace(start: any, stop: any, num?: number, endpoint?: boolean): NDArray;
 export declare function geomspace(start: any, stop: any, num?: number, endpoint?: boolean): NDArray;

diff --git a/dist/modules/constructors.d.ts.map b/dist/modules/constructors.d.ts.map
diff --git a/docs-src/generate-examples.ts b/docs-src/generate-examples.ts
diff --git a/docs-src/index.md b/docs-src/index.md
@@ -1,5 +1,3 @@
-
-
 <script src="https://cdn.jsdelivr.net/npm/ndarray-js@1.0.0/dist/index.js"></script>
 <script src="https://d3js.org/d3.v7.min.js"></script>
 <script src="https://cdn.jsdelivr.net/npm/@observablehq/plot@0.6/dist/plot.umd.min.js"></script>

diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/NDArray.html b/docs/classes/NDArray.html
diff --git a/docs/classes/_internals_.PExpr.html b/docs/classes/_internals_.PExpr.html