tldr_traits/lib.rs
1// This is free and unencumbered software released into the public domain.
2
3//! This crate provides abstractions for TL;DR summarization using the [five Ws]:
4//!
5//! > **The Five Ws** is a checklist used in journalism to ensure that the lead
6//! > contains all the essential points of a story. As far back as 1913,
7//! > reporters were taught that the lead should answer these questions:
8//! >
9//! > - Who? – asking about a person or other agent
10//! > - What? – asking about an object or action
11//! > - When? – asking about a time
12//! > - Where? – asking about a place
13//! > - Why? – asking about a reason or cause
14//! >
15//! > In modern times, journalism students are still taught that these are the
16//! > fundamental five questions of newswriting.
17//!
18//! [five Ws]: https://en.wikipedia.org/wiki/Five_Ws
19//!
20//! # Examples
21//!
22//! ```rust,ignore
23//! use tldr::{Tldr, TldrContext, TldrLanguage, TldrResult, TldrSummary, ToTldr};
24//! ```
25#![no_std]
26#![forbid(unsafe_code)]
27
28#[doc = include_str!("../README.md")]
29#[cfg(doctest)]
30pub struct ReadmeDoctests;
31
32extern crate alloc;
33
34mod context;
35pub use context::*;
36
37mod language;
38pub use language::*;
39
40mod result;
41pub use result::*;
42
43mod summary;
44pub use summary::*;
45
46mod traits;
47pub use traits::*;