Skip to content

Commit

Permalink
[#2] Revise markdown in doc tests
Browse files Browse the repository at this point in the history
  • Loading branch information
kodemartin committed Jul 18, 2021
1 parent 9380bc7 commit bdd1967
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/address.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ pub struct AddressParserOptions {
impl AddressParserOptions {
/// Create options for the address parser.
///
/// ## Examples
/// # Examples
///
/// ```
/// use rustpostal::address;
Expand Down
8 changes: 4 additions & 4 deletions src/expand.rs
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ impl NormalizeOptions {

/// Expand address into normalized variations using libpostal.
///
/// ## Examples
/// # Examples
///
/// ```
/// use std::ffi::NulError;
Expand All @@ -360,7 +360,7 @@ impl NormalizeOptions {
/// }
/// ```
///
/// ## Errors
/// # Errors
///
/// The method will return an error if the supplied address
/// contains an internal null byte. The error is represented by
Expand Down Expand Up @@ -415,7 +415,7 @@ impl<'a> IntoIterator for &'a mut NormalizedAddress {

/// Normalize address with default options.
///
/// ## Errors
/// # Errors
///
/// The method will return an error if the supplied address
/// contains an internal null byte. The error is represented by
Expand All @@ -427,7 +427,7 @@ pub fn expand_address<'a>(address: &'a str) -> Result<NormalizedAddress, NulErro

/// Normalize address with optional user-defined languages.
///
/// ## Errors
/// # Errors
///
/// The method will return an error if the supplied address
/// contains an internal null byte. The error is represented by
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ unsafe fn teardown_classifier() {
impl LibModules {
/// Setup the necessary `libpostal` resources.
///
/// ## Examples
/// # Examples
/// ```
/// use rustpostal::error::SetupError;
/// use rustpostal::LibModules;
Expand Down

0 comments on commit bdd1967

Please sign in to comment.