Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Copyediting #90

Merged
merged 1 commit into from Mar 11, 2024
Merged

Copyediting #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -82,7 +82,7 @@ js-wacz create --file "collection/*.warc"

### --output, -o

Allows to specify where the resulting `.wacz` file should be created, and what its filename should be.
Specify where the resulting `.wacz` file should be created, and what its filename should be.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My brain wants to use "Specifies" and I am not sure why 🤔 . What do you think @bensteinberg ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could see it either way. There could be an implicit "This option": "(This option) Specifies" -- or an implicit "This option allows you to" or "With this option you can": "(This option allows you to) Specify".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I incline toward the latter in the interest of saving precious characters ;) but I'm happy to change these.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, that makes sense to me, let's ship it :D ! thanks again


Defaults to `archive.wacz` in the current directory if not provided.

Expand All @@ -92,7 +92,7 @@ js-wacz create --file cool-beans.warc --output cool-beans.wacz

### --pages, -p

Allows to pass a specific [pages.jsonl](https://specs.webrecorder.net/wacz/1.1.1/#pages-jsonl) file.
Pass a specific [pages.jsonl](https://specs.webrecorder.net/wacz/1.1.1/#pages-jsonl) file.

If not provided, **js-wacz** is going to attempt to detect pages in WARC records to build its own `pages.jsonl` index.

Expand All @@ -102,7 +102,7 @@ js-wacz create -f "collection/*.warc.gz" --pages collection/pages.jsonl

### --cdxj

Allows to pass a directory of existing CDXJ files, rather than indexing from WARCs. Must be used in combination with `--pages`.
Pass a directory of existing CDXJ files, rather than indexing from WARCs. Must be used in combination with `--pages`.

```bash
js-wacz create -f "collection/*.warc.gz" --pages collection/pages.jsonl --cdxj collection/indexes/
Expand Down
4 changes: 2 additions & 2 deletions index.js
View file
Open in desktop
Expand Up @@ -763,7 +763,7 @@ export class WACZ {
}

/**
* Allows to manually add an entry for pages.jsonl.
* Manually add an entry for pages.jsonl.
* Entries will be added to `this.pagesTree`.
* Calling this method automatically turns pages detection off.
* @param {string} url - Must be a valid url
Expand Down Expand Up @@ -805,7 +805,7 @@ export class WACZ {
}

/**
* Allows to manually add a CDJX entry to `this.cdxTree`.
* Manually add a CDJX entry to `this.cdxTree`.
* Calling this method automatically turns indexing from WARCS off.
* @param {string} cdjx - CDJX as string
* @returns {Promise<void>}
Expand Down