Skip to content

Commit 105e417

Browse files
committed
Minor docfixes, added more keywords.
1 parent 8607a50 commit 105e417

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ We created a separate package rather than attempting to bundle the Wasm files in
88

99
## Quick start
1010

11-
We assume that the `*.kana` file has been split into the HDF5 file, e.g., using **bakana**'s `parseKanaFile()` function.
11+
We assume that the `*.kana` file has been parsed to obtain the embedded HDF5 file, e.g., using **bakana**'s `parseKanaFile()` function.
1212

1313
```js
1414
import * as va from "valkana";

docs/jsdoc.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"scripts": [],
1616
"menu":{
1717
"Github repo": {
18-
"href":"https://github.com/LTLA/bakana",
18+
"href":"https://github.com/LTLA/valkana",
1919
"target":"_blank",
2020
"class":"menu-item",
2121
"id":"repository"

js/validate.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import * as wasm from "./wasm.js";
22

33
/**
44
* Validate the HDF5 state file containing the analysis parameters and results.
5-
* It is assumed that the HDF5 state file has already been extracted from the kana file,
5+
* It is assumed that the HDF5 state file has already been extracted from the `*.kana` file,
66
* e.g., using **bakana**'s `parseKanaFile` function.
77
*
88
* @param {string} path - Path to the HDF5 file.

js/wasm.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const cache = {};
1010
*
1111
* @return {boolean}
1212
* The Wasm bindings are initialized and `true` is returned.
13-
* If the bindings were already initialized (e.g., by a previous call), nothing is done and `false` is returned.
13+
* If the bindings were already initialized (e.g., by a previous call to `initialize`), nothing is done and `false` is returned.
1414
*/
1515
export async function initialize({ localFile = false } = {}) {
1616
let options = {};

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818
"repository": "github:LTLA/valkana",
1919
"bugs": "https://github.com/LTLA/valkana/issues",
2020
"keywords": [
21-
"single-cell"
21+
"bioinformatics",
22+
"scRNA-seq",
23+
"single-cell",
24+
"webassembly"
2225
],
2326
"devDependencies": {
2427
"docdash": "^1.2.0",

0 commit comments

Comments
 (0)