clockworklabs / clockworklabs/SpacetimeDB
Document `table(scheduled(at = col_name))` syntax
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
From our macro code:
let scheduled_at_column = scheduled_at_column.ok_or_else(|| {
syn::Error::new(
sched.span,
"scheduled tables must have a `scheduled_at: spacetimedb::ScheduleAt` column. \
if the column has a name besides `scheduled_at`, you can specify it with \
`scheduled(my_reducer, at = custom_scheduled_at)`",
)
})?;
This syntax, with the at = col_name parameter supplied, does not appear in our docs, and is not regression-tested. Expand the docs of scheduled reducers, which are attached to the spacetimedb_bindings_table re-export in the bindings crate's lib.rs.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the bindings crate's lib.rs, where the scheduled reducer documentation is attached to the spacetimedb_bindings_table re-export. Document the table(scheduled(at = col_name)) form and review the existing scheduled reducer examples. Add regression coverage for the custom scheduled_at column syntax, and consider the work done when both the docs and behavior are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100