search

Thomasdezeeuw / gaea

Low-level library to build event driven applications, supporting lightweight non-blocking I/O.
https://docs.rs/gaea/
MIT License
16 stars 0 forks source link

Fix documentation intralinks #76

Closed Thomasdezeeuw closed 5 years ago

Thomasdezeeuw commented 5 years ago

When documentation the crate from another I get the following warnings:

warning: `[Capacity::Growable]` cannot be resolved, ignoring it...
   --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/event.rs:208:26
    |
208 |     /// If this returns [`Capacity::Growable`] and the capacity left is
    |                          ^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Source::blocking_poll]` cannot be resolved, ignoring it...
  --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/event.rs:91:26
   |
91 |     /// [blocking call]: Source::blocking_poll
   |                          ^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Events]` cannot be resolved, ignoring it...
  --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/event.rs:99:33
   |
99 |     /// Some implementation of [`Events`] have a limited available capacity.
   |                                 ^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Events::capacity_left]` cannot be resolved, ignoring it...
   --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/event.rs:100:51
    |
100 |     /// This method may not add more events then [`Events::capacity_left`]
    |                                                   ^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Source::poll]` cannot be resolved, ignoring it...
   --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/event.rs:109:30
    |
109 |     /// This is the same as [`Source::poll`] and all requirements of that method
    |                              ^^^^^^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[crate::os::OsQueue::register]` cannot be resolved, ignoring it...
  --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/os/evented.rs:76:31
   |
76 |     /// [`OsQueue.register`]: crate::os::OsQueue::register
   |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[crate::os::OsQueue::reregister]` cannot be resolved, ignoring it...
  --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/os/evented.rs:84:33
   |
84 |     /// [`OsQueue.reregister`]: crate::os::OsQueue::reregister
   |                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[crate::os::OsQueue::deregister]` cannot be resolved, ignoring it...
  --> /Users/thomas/.cargo/git/checkouts/mio-st-36dfa78dd2dc66e1/518d5ec/src/os/evented.rs:92:33
   |
92 |     /// [`OsQueue.deregister`]: crate::os::OsQueue::deregister
   |                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

    Finished dev [unoptimized + debuginfo] target(s) in 8.90s
Thomasdezeeuw commented 5 years ago

Only happens in one project, but not in a newly created one so I'm going to close this for now.