Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b016a59

Browse files
committed
refactor!: Move around items in the public api
BREAKING CHANGE: This moves `snippet::*` and `Renderer` to root
1 parent 51506e9 commit b016a59

File tree

11 files changed

+38
-43
lines changed

11 files changed

+38
-43
lines changed

‎benches/simple.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ extern crate criterion;
44

55
use criterion::{black_box, Criterion};
66

7-
use annotate_snippets::renderer::Renderer;
8-
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
7+
use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation};
98

109
fn create_snippet(renderer: Renderer) {
1110
let snippet = Snippet {

‎examples/expected_type.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
use annotate_snippets::renderer::Renderer;
2-
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
1+
use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation};
32

43
fn main() {
54
let snippet = Snippet {

‎examples/footer.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
use annotate_snippets::renderer::Renderer;
2-
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
1+
use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation};
32

43
fn main() {
54
let snippet = Snippet {

‎examples/format.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
use annotate_snippets::renderer::Renderer;
2-
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
1+
use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation};
32

43
fn main() {
54
let snippet = Snippet {

‎examples/multislice.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
use annotate_snippets::renderer::Renderer;
2-
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet};
1+
use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet};
32

43
fn main() {
54
let snippet = Snippet {

‎src/lib.rs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,22 @@
2929
//! Snippet --> Renderer --> impl Display
3030
//! ```
3131
//!
32-
//! The input type - [Snippet](self::snippet) is a structure designed
32+
//! The input type - [Snippet] is a structure designed
3333
//! to align with likely output from any parser whose code snippet is to be
3434
//! annotated.
3535
//!
36-
//! The middle structure - [Renderer](self::renderer) is a structure designed
36+
//! The middle structure - [Renderer] is a structure designed
3737
//! to convert a snippet into an internal structure that is designed to store
3838
//! the snippet data in a way that is easy to format.
39-
//! [Renderer](self::renderer) also handles the user-configurable formatting
39+
//! [Renderer] also handles the user-configurable formatting
4040
//! options, such as color, or margins.
4141
//!
4242
//! Finally, `impl Display` into a final `String` output.
4343
4444
mod display_list;
4545
pub mod renderer;
46-
pub mod snippet;
46+
mod snippet;
47+
48+
#[doc(inline)]
49+
pub use renderer::Renderer;
50+
pub use snippet::*;

‎src/renderer/mod.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
//!
33
//! # Example
44
//! ```
5-
//! use annotate_snippets::renderer::Renderer;
6-
//! use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet};
5+
//! use annotate_snippets::{Annotation, AnnotationType, Renderer, Slice, Snippet};
76
//! let snippet = Snippet {
87
//! title: Some(Annotation {
98
//! label: Some("mismatched types"),

‎src/snippet.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Example:
44
//!
55
//! ```
6-
//! use annotate_snippets::snippet::*;
6+
//! use annotate_snippets::*;
77
//!
88
//! Snippet {
99
//! title: Some(Annotation {

‎tests/deserialize/mod.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
use serde::{Deserialize, Deserializer, Serialize};
22

3-
use annotate_snippets::renderer::Renderer;
43
use annotate_snippets::{
5-
renderer::Margin,
6-
snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
4+
renderer::Margin, Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation,
75
};
86

97
#[derive(Deserialize)]

‎tests/fixtures_test.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ mod deserialize;
22
mod diff;
33

44
use crate::deserialize::Fixture;
5-
use annotate_snippets::renderer::Renderer;
6-
use annotate_snippets::snippet::Snippet;
5+
use annotate_snippets::Renderer;
6+
use annotate_snippets::Snippet;
77
use glob::glob;
88
use std::{error::Error, fs::File, io, io::prelude::*};
99

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /