Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs-rs fixes #264

Merged
merged 2 commits into from
Mar 13, 2024
Merged

Docs-rs fixes #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9433a9
docrs: fix missing features
geofmureithi Mar 10, 2024
6fa84d5
docs: minor fixes
geofmureithi Mar 13, 2024
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
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ layers = [
"filter",
]

docsrs = ["document-features"]

[dependencies.apalis-redis]
version = "0.5.0"
optional = true
Expand Down
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ apalis = { version = "0.5", features = ["redis"] } # Backends available: postgre

## Usage

````rust
```rust
use apalis::prelude::*;
use apalis::redis::RedisStorage;
use serde::{Deserialize, Serialize};
Expand All @@ -80,7 +80,6 @@ impl Job for Email {
}

/// A function that will be converted into a service.
/// ```
async fn send_email(job: Email, data: Data<usize>) -> Result<(), Error> {
/// execute job
Ok(())
Expand All @@ -103,7 +102,7 @@ async fn main() -> Result<()> {
.await
}

````
```

Then

Expand Down Expand Up @@ -134,7 +133,6 @@ async fn produce_route_jobs(storage: &RedisStorage<Email>) -> Result<()> {
- _timeout_ — Support timeouts on jobs
- _limit_ — 💪 Limit the amount of jobs
- _filter_ — Support filtering jobs based on a predicate
- _extensions_ — Add a global extensions to jobs

## Storage Comparison

Expand Down Expand Up @@ -176,6 +174,7 @@ sequenceDiagram

- [Ryot](https://github.com/IgnisDa/ryot): A self hosted platform for tracking various facets of your life - media, fitness etc.
- [Summarizer](https://github.com/akhildevelops/summarizer): Podcast summarizer
- [Universal Inbox](https://github.com/universal-inbox/universal-inbox): Universal Inbox is a solution that centralizes all your notifications and tasks in one place to create a unique inbox.

## Resources

Expand Down
Loading