Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Get help

Where to ask

WhatWhere
Feedback, bug reports, requests for repository accessDiscord, until a feedback address is set
Informal chat, quick questionsDiscord
Bug reports and feature requestsGitHub issues — requires repository access
Open-ended discussionGitHub discussions — requires repository access

The feedback address is a placeholder until the project lead sets one. Until then, use the Discord channel: the repository’s issues and discussions are private, so they only work for people who already have repository access.

Getting access to the CLI and Python client

Both live in the private repository. To request read access, use the feedback address or ask on Discord, and include:

  • your GitHub username,
  • your institution and role (professor, postdoc, PhD student, other),
  • what you intend to do (for example: query the corpus, contribute a dataset).

Access is tied to the GitHub account you name; do not share tokens or credentials with anyone else. The web app and the public API at https://api.syndb.xyz need no access.

Reporting a bug

Include enough that the report can be reproduced:

  1. What you did — the page or command. For a query, paste the full SyQL text; for the CLI, paste the command line without any token.
  2. What happened — the error text, or the job ID from the job page.
  3. What you expected — one sentence is enough.
  4. Dataset IDs involved, if the problem is about data rather than the service. IDs are UUIDs like 676f5945-b47e-5ed9-9279-401342059449.
  5. When — date and approximate time, with your time zone.

Job IDs are private to the account that created them. If you report a problem with a job, attach the query text and the exported result file as well; nobody else can open the ID.

Never paste an access token, refresh token or SERVICE_SECRET into an issue or a chat message.

Asking a data question

For “does this dataset contain what I need”, check Tables, columns and units and the dataset page first. The dataset page lists the tables it carries and how many rows each holds.

For “is this number right”, say what you computed, the dataset ID, and the query text. Counts are defined narrowly (see the notes in the worked example), and most disagreements turn out to be a difference in denominator, row unit or measurement unit.