Skip to content

Commit

Permalink
docs(compare-images): correct package description
Browse files Browse the repository at this point in the history
  • Loading branch information
thewtex committed Aug 21, 2023
1 parent dd44f54 commit 40f47cb
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
"build:bindgen:typescript:dicom": "./src/itk-wasm-cli.js -s packages/dicom -b emscripten-build bindgen --package-version 3.2.0 --package-name @itk-wasm/dicom --package-description \"Read files and images related to DICOM file format.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:bindgen:python:dicom": "./src/itk-wasm-cli.js -s packages/dicom -b wasi-build bindgen --package-version 3.2.0 --interface python --package-name itkwasm-dicom --package-description \"Read files and images related to DICOM file format.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:emscripten:compare-images": "node ./src/itk-wasm-cli.js -s packages/compare-images -b emscripten-build build",
"build:bindgen:typescript:compare-images": "./src/itk-wasm-cli.js -s packages/compare-images -b emscripten-build bindgen --package-version 1.0.0 --package-name @itk-wasm/compare-images --package-description \"Read files and images related to compare-images file format.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:bindgen:python:compare-images": "./src/itk-wasm-cli.js -s packages/compare-images -b wasi-build bindgen --package-version 1.0.0 --interface python --package-name itkwasm-compare-images --package-description \"Read files and images related to compare-images file format.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:bindgen:typescript:compare-images": "./src/itk-wasm-cli.js -s packages/compare-images -b emscripten-build bindgen --package-version 1.0.0 --package-name @itk-wasm/compare-images --package-description \"Compare images with a tolerance for regression testing.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:bindgen:python:compare-images": "./src/itk-wasm-cli.js -s packages/compare-images -b wasi-build bindgen --package-version 1.0.0 --interface python --package-name itkwasm-compare-images --package-description \"Compare images with a tolerance for regression testing.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
"build:emscripten:packages": "npm run build:emscripten:compress-stringify && npm run build:bindgen:typescript:compress-stringify && npm run build:emscripten:dicom && npm run build:bindgen:typescript:dicom && npm run build:emscripten:compare-images && npm run build:bindgen:typescript:compare-images",
"build:wasi": "node ./src/build-wasi.js && npm run build:wasi:packages",
"build:wasi:compress-stringify": "node ./src/itk-wasm-cli.js -i itkwasm/wasi:latest -s packages/compress-stringify -b wasi-build build",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PyPI version](https://badge.fury.io/py/itkwasm-compare-images-emscripten.svg)](https://badge.fury.io/py/itkwasm-compare-images-emscripten)

Read files and images related to compare-images file format. Emscripten implementation.
Compare images with a tolerance for regression testing. Emscripten implementation.

This package provides the Emscripten WebAssembly implementation. It is usually not called directly. Please use the [`itkwasm-compare-images`](https://pypi.org/project/itkwasm-compare-images/) instead.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""itkwasm-compare-images-emscripten: Read files and images related to compare-images file format. Emscripten implementation."""
"""itkwasm-compare-images-emscripten: Compare images with a tolerance for regression testing. Emscripten implementation."""

from .compare_double_images_async import compare_double_images_async
from .vector_magnitude_async import vector_magnitude_async
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PyPI version](https://badge.fury.io/py/itkwasm-compare-images-wasi.svg)](https://badge.fury.io/py/itkwasm-compare-images-wasi)

Read files and images related to compare-images file format. WASI implementation.
Compare images with a tolerance for regression testing. WASI implementation.

This package provides the WASI WebAssembly implementation. It is usually not called directly. Please use [`itkwasm-compare-images`](https://pypi.org/project/itkwasm-compare-images/) instead.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""itkwasm-compare-images-wasi: Read files and images related to compare-images file format. WASI implementation."""
"""itkwasm-compare-images-wasi: Compare images with a tolerance for regression testing. WASI implementation."""

from .compare_images import compare_images
from .compare_double_images import compare_double_images
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PyPI version](https://badge.fury.io/py/itkwasm-compare-images.svg)](https://badge.fury.io/py/itkwasm-compare-images)

Read files and images related to compare-images file format.
Compare images with a tolerance for regression testing.

## Installation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
itkwasm-compare-images
=======

> Read files and images related to compare-images file format.
> Compare images with a tolerance for regression testing.
[![itkwasm-compare-images version](https://badge.fury.io/py/itkwasm_compare_images.svg)](https://pypi.org/project/itkwasm_compare_images/)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""itkwasm-compare-images: Read files and images related to compare-images file format."""
"""itkwasm-compare-images: Compare images with a tolerance for regression testing."""

from .compare_double_images_async import compare_double_images_async
from .compare_double_images import compare_double_images
Expand Down
2 changes: 1 addition & 1 deletion packages/compare-images/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![npm version](https://badge.fury.io/js/@itk-wasm%2Fcompare-images.svg)](https://www.npmjs.com/package/@itk-wasm/compare-images)

> Read files and images related to compare-images file format.
> Compare images with a tolerance for regression testing.
## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/compare-images/typescript/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<title>@itk-wasm/compare-images</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Read files and images related to compare-images file format.">
<meta name="description" content="Compare images with a tolerance for regression testing.">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
<link rel="stylesheet" media="(prefers-color-scheme: light)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
Expand Down
2 changes: 1 addition & 1 deletion packages/compare-images/typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@itk-wasm/compare-images",
"version": "1.0.0",
"description": "Read files and images related to compare-images file format.",
"description": "Compare images with a tolerance for regression testing.",
"type": "module",
"module": "./dist/bundles/compare-images.js",
"types": "./dist/src/index.d.ts",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
</a>

<h2>@itk-wasm/compare-images<img src="./javascript-logo.svg" alt="JavaScript logo" class="language-logo"/><img src="./typescript-logo.svg" alt="TypeScript logo" class="language-logo"/></h2>
<i>Read files and images related to compare-images file format.</i>
<i>Compare images with a tolerance for regression testing.</i>
<h3>👨‍💻 Live API Demo ✨</h3>
<br /><br />

<sl-tab-group>
Expand Down

0 comments on commit 40f47cb

Please sign in to comment.