Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ this community's docs work" from drifting apart.

```bash
# read side
cd js && npm install && npm test
(cd js && npm install && npm test)

# write side
cd python && python3 -m unittest discover -s tests -v
(cd python && PYTHONPATH=src python3 -m unittest discover -s tests -v)
```

CI runs both on every push and pull request.
Expand Down
2 changes: 1 addition & 1 deletion js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ docs.resolveLink('rules.md', 'handbook/getting-started.md');

| Option | Default | What it does |
|---|---|---|
| `repo` | *(required)* | `owner/repo`, or a GitHub URL. Validated when the client is builtthe only place this package throws. |
| `repo` | *(required)* | `owner/repo`, or a GitHub URL. Validated when the client is built, and an unusable value throws there. (`webUrl` and `rawUrl` also throw, for a target that is not in the catalogue; `fetchMarkdown` returns `not-listed` instead.) |
| `ref` | `'HEAD'` | The git ref to read. `HEAD` resolves to the default branch whatever it is called. |
| `token` | none | A read token, for a private repository. Omit for a public one. |
| `transport` | `'api'` with a token, `'raw'` without | Contents API vs `raw.githubusercontent.com`. |
Expand Down
3 changes: 2 additions & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ a control that depends on somebody else's behaviour is not a control.
## Development

```bash
python3 -m unittest discover -s tests -v
# from python/, with src/ on the path — or after `pip install -e .`
PYTHONPATH=src python3 -m unittest discover -s tests -v
```

The tests mock `urllib.request.urlopen` with a small fake GitHub API keyed on
Expand Down
Loading