Skip to content

docs: document API-error exceptions and request timeouts#241

Merged
bjornars merged 2 commits into
novem-code:mainfrom
bjornars:bsn/docs-error-handling-timeouts
Jun 18, 2026
Merged

docs: document API-error exceptions and request timeouts#241
bjornars merged 2 commits into
novem-code:mainfrom
bjornars:bsn/docs-error-handling-timeouts

Conversation

@bjornars

Copy link
Copy Markdown
Contributor

Documents the two newest SDK changes in the README, which had no coverage of either behaviour.

What

  • sdk: raise NovemException on API errors instead of a print placeholder #236 — API errors now raise. Writes raise NovemException (or a subclass) carrying the server message instead of the old silent print placeholder. New README Error handling section documents the exception hierarchy (all importable from novem.exceptions), a try/except example, and the create-PUT 409 no-op for objects that already exist. Notes that the Plot(...) constructor itself is a create PUT (unless create=False) and can raise.
  • fix: add request timeouts to prevent indefinite hangs (#239) #240 — request timeouts. New Timeouts subsection: every call defaults to (10s connect, 2min read), job.run() allows (30s connect, 30min read), and exceeding either raises requests.exceptions.Timeout.

Commits

  1. docs: document API-error exceptions and request timeouts — the new content.
  2. docs: README style pass for docs-site conventions — aligns the README with the docs-site style guide (NB:Note:, fix two comma splices and an already exist typo, add Oxford commas, recast paired-em-dash asides, keep single em-dashes where they fit).

Docs-only; no code changes.

bjornars added 2 commits June 18, 2026 10:25
Add a README "Error handling" section covering the two newest changes:

- PR novem-code#236: writes now raise NovemException (or a subclass) carrying the
  server message instead of silently printing a placeholder. Documents the
  exception hierarchy (all importable from novem.exceptions) and the create
  PUT 409 no-op for objects that already exist.
- PR novem-code#240: requests now time out instead of hanging, with the default
  (10s, 2min) and job.run() (30s, 30min) values and the resulting
  requests.exceptions.Timeout.
Align the README with the docs-site style guide: direct prose, em-dashes used
sparingly (not paired twice a sentence), Oxford-spec punctuation, complete
sentences, and Note: callouts.

- NB: -> Note: on the two inline callouts
- fix two comma splices and the "already exist" typo
- add Oxford commas; recast the paired-em-dash asides as parentheses/sentences
- keep single, well-placed em-dashes where they earn their place
@bjornars bjornars merged commit ac361b9 into novem-code:main Jun 18, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants