Skip to content

Commit

Permalink
Fix markdown syntax to be compatible with the pulldown parser.
Browse files Browse the repository at this point in the history
This fixes warnings like the following when doing "cargo doc":

WARNING: documentation for this crate may be rendered differently using the new Pulldown renderer.
    See rust-lang/rust#44229 for details.
WARNING: rendering difference in `External types as defined at https://webassembly.g ... .html#external-types`
   --> src/parser.rs:104:0
    /html[0]/body[1]/p[0] Text differs:
        expected: `... https://webassembly.github.io/spec/syntax/types.html#external-types`
        found:    `...`
  • Loading branch information
sunfishcode committed Jan 16, 2018
1 parent 0991ed3 commit 36790be
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions src/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ pub enum CustomSectionKind {
Linking,
}

/// Section code as defined at https://webassembly.github.io/spec/binary/modules.html#sections
/// Section code as defined [here].
///
/// [here]: https://webassembly.github.io/spec/binary/modules.html#sections
#[derive(Debug,Copy,Clone,PartialEq,Eq,PartialOrd,Ord)]
pub enum SectionCode<'a> {
Custom {
Expand All @@ -61,7 +63,9 @@ pub enum SectionCode<'a> {
Data, // Data segments
}

/// Types as defined at https://webassembly.github.io/spec/syntax/types.html#types
/// Types as defined [here].
///
/// [here]: https://webassembly.github.io/spec/syntax/types.html#types
#[derive(Debug,Copy,Clone,PartialEq,Eq)]
pub enum Type {
I32,
Expand Down Expand Up @@ -99,7 +103,9 @@ pub enum NameEntry<'a> {
Local(Vec<LocalName<'a>>),
}

/// External types as defined at https://webassembly.github.io/spec/syntax/types.html#external-types
/// External types as defined [here].
///
/// [here]: https://webassembly.github.io/spec/syntax/types.html#external-types
#[derive(Debug, Copy, Clone)]
pub enum ExternalKind {
Function,
Expand Down Expand Up @@ -281,7 +287,9 @@ impl Ieee64 {
}
}

/// Instructions as defined at https://webassembly.github.io/spec/binary/instructions.html
/// Instructions as defined [here].
///
/// [here]: https://webassembly.github.io/spec/binary/instructions.html
#[derive(Debug)]
pub enum Operator<'a> {
Unreachable,
Expand Down

0 comments on commit 36790be

Please sign in to comment.