# sphpkg

*module*

Small package with sphinx-style docstrings.

Exists so the parser tests cover the reStructuredText field list syntax
(`:param x:`, `:returns:`, `:raises:`).

## sphpkg.Job

*class*

```python
class Job
```

A unit of queued work.

**Parameters**

- `label` (`str`) — Human readable job label.
- `priority` (`int`) (default: `0`) — Queue priority, higher runs first.

### sphpkg.Job.label

*attribute* · *instance attribute*

```python
label = label
```

### sphpkg.Job.priority

*attribute* · *instance attribute*

```python
priority = priority
```

### sphpkg.Job.describe

*method*

```python
def describe() -> str
```

Summarise the job.

**Returns**

- (`str`) — A single line of plain text.

## sphpkg.submit

*function*

```python
def submit(job: Job, *, dry_run: bool = False) -> str
```

Queue a job for execution.

**Parameters**

- `job` (`Job`) — The job to queue.
- `dry_run` (`bool`) (default: `False`) — When true, validate without queueing.

**Returns**

- (`str`) — The identifier assigned to the job.

**Raises**

- `ValueError` — If the job has an empty label.