Fix some intra-doc-links (and some others)

crates/rune-languageserver/src/state.rs

@@ -406,7 +406,7 @@ fn span_to_lsp_range(source: &runestick::Source, span: Span) -> Option<lsp::Rang
 /// Translate the given lsp::Position, which is in UTF-16 because Microsoft.
 ///
 /// Please go complain here:
-/// https://github.com/microsoft/language-server-protocol/issues/376
+/// <https://github.com/microsoft/language-server-protocol/issues/376>
 fn rope_utf16_position(rope: &Rope, position: lsp::Position) -> Result<usize> {
     let line = rope.line(position.line as usize);
 

crates/rune-macros/src/lib.rs

@@ -42,8 +42,7 @@
 //!
 //! Macros for Rune.
 //!
-//! This is part of the [Rune language].
-//! [Rune Language]: https://rune-rs.github.io
+//! This is part of the [Rune Language](https://rune-rs.github.io).
 
 extern crate proc_macro;
 

crates/rune-modules/src/lib.rs

@@ -93,6 +93,10 @@
 //! [time]: https://docs.rs/rune-modules/0/rune_modules/time/
 //! [toml]: https://docs.rs/rune-modules/0/rune_modules/toml/
 
+// Note: The above links to docs.rs are needed because cargo-readme does not
+// support intra-doc links (yet):
+// https://github.com/livioribeiro/cargo-readme/issues/55
+
 #[cfg(feature = "experiments")]
 pub mod experiments;
 

crates/rune/src/ast/lit.rs

@@ -59,7 +59,7 @@ impl Lit {
     /// a later stage as an expression is being parsed.
     ///
     /// These include:
-    /// * Object literals that start with a path (handled in [ast::Expr::parse_ident_start]).
+    /// * Object literals that start with a path (handled in [ast::Expr::parse_with_meta_path]).
     /// * Tuple literals that start with a path (handled in [ast::Expr::parse_open_paren]).
     pub(crate) fn peek_in_expr(p: &mut Peeker<'_>) -> bool {
         match p.nth(0) {

crates/rune/src/compiling/unit_builder.rs

@@ -118,7 +118,7 @@ impl UnitBuilder {
     }
 
     /// Insert a static string and return its associated slot that can later be
-    /// looked up through [lookup_string][Self::lookup_string].
+    /// looked up through [lookup_string][Unit::lookup_string].
     ///
     /// Only uses up space if the static string is unique.
     pub(crate) fn new_static_string(
@@ -163,7 +163,7 @@ impl UnitBuilder {
     }
 
     /// Insert a static byte string and return its associated slot that can
-    /// later be looked up through [lookup_bytes][Self::lookup_bytes].
+    /// later be looked up through [lookup_bytes][Unit::lookup_bytes].
     ///
     /// Only uses up space if the static byte string is unique.
     pub(crate) fn new_static_bytes(

crates/rune/src/ir/mod.rs

@@ -1,8 +1,7 @@
 //! Intermediate representation of Rune that can be evaluated in constant
 //! contexts.
 //!
-//! This is part of the [Rune Language].
-//! [Rune Language]: https://rune-rs.github.io
+//! This is part of the [Rune Language](https://rune-rs.github.io).
 
 mod eval;
 mod ir_compiler;

crates/rune/src/load/mod.rs

@@ -12,7 +12,7 @@ pub use self::sources::Sources;
 
 /// Error raised when we failed to load sources.
 ///
-/// Look at the passed in [Errors] instance for details.
+/// Look at the passed in [Diagnostics] instance for details.
 #[derive(Debug, Error)]
 #[error("failed to load sources (see `errors` for details)")]
 pub struct LoadSourcesError;

crates/rune/src/query/mod.rs

@@ -1630,7 +1630,7 @@ pub(crate) struct QueryConstFn {
     pub(crate) ir_fn: ir::IrFn,
 }
 
-/// The result of calling [Query::find_named].
+/// The result of calling [Query::convert_path].
 #[derive(Debug)]
 pub struct Named {
     /// If the resolved value is local.

crates/runestick-macros/src/lib.rs

@@ -43,8 +43,7 @@
 //! Macros for Runestick, a stack-based virtual machine for the Rust programming
 //! language.
 //!
-//! This is part of the [Rune language].
-//! [Rune Language]: https://rune-rs.github.io
+//! This is part of the [Rune Language](https://rune-rs.github.io).
 
 extern crate proc_macro;
 

crates/runestick/src/env.rs

@@ -1,9 +1,9 @@
 //! Thread-local access to the current context.
 //!
 //! This provides access to functions to call specific protocol functions, like:
-//! * [into_iter]
-//! * [string_debug]
-//! * [into_type_name]
+//! * [super::Value::into_iter]
+//! * [super::Value::string_debug]
+//! * [super::Value::into_type_name]
 //!
 //! See the corresponding function for documentation.
 

crates/runestick/src/iterator.rs

@@ -676,7 +676,7 @@ where
 /// The trait for interacting with an iterator.
 ///
 /// This has a blanket implementation, and is primarily used to restrict the
-/// arguments that can be used in [Iterator::from_iterator].
+/// arguments that can be used in [Iterator::from].
 pub trait IteratorTrait: 'static {
     /// Size hint of the iterator.
     fn size_hint(&self) -> (usize, Option<usize>);

crates/runestick/src/lib.rs

@@ -42,8 +42,7 @@
 //!
 //! A stack-based virtual machine for the Rust programming language.
 //!
-//! This is the driver for the [Rune language].
-//! [Rune Language]: https://rune-rs.github.io
+//! This is the driver for the [Rune Language](https://rune-rs.github.io).
 
 #![deny(missing_docs)]
 #![allow(clippy::enum_variant_names, clippy::too_many_arguments)]