From 58ca728c5f6ef3987f003a261b33deb716cd3173 Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Sun, 15 Nov 2020 17:57:06 +0100 Subject: [PATCH] Fix rustdoc warnings (#526) This commit attempts to fix the reported warnings that are generated by rustdoc. --- src/bigint.rs | 2 ++ src/data.rs | 4 ++-- src/promise.rs | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/bigint.rs b/src/bigint.rs index a68838f5..59370726 100644 --- a/src/bigint.rs +++ b/src/bigint.rs @@ -57,7 +57,9 @@ impl BigInt { /// specified list of digits/words. /// The resulting number is calculated as: /// + /// ``` /// (-1)^sign_bit * (words[0] * (2^64)^0 + words[1] * (2^64)^1 + ...) + /// ``` pub fn new_from_words<'s>( scope: &mut HandleScope<'s>, sign_bit: bool, diff --git a/src/data.rs b/src/data.rs index e56c1dc3..6706a8c2 100644 --- a/src/data.rs +++ b/src/data.rs @@ -503,7 +503,7 @@ impl_partial_eq! { ObjectTemplate for Template use identity } /// and "instance" for the instance object created above. The function /// and the instance will have the following properties: /// -/// ```ignore +/// ```javascript,ignore /// func_property in function == true; /// function.func_property == 1; /// @@ -547,7 +547,7 @@ impl_partial_eq! { ObjectTemplate for Template use identity } /// The Child function and Child instance will have the following /// properties: /// -/// ```ignore +/// ```javascript,ignore /// child_func.prototype.__proto__ == function.prototype; /// child_instance.instance_accessor calls 'InstanceAccessorCallback' /// child_instance.instance_property == 3; diff --git a/src/promise.rs b/src/promise.rs index 10517cd4..d65f81f1 100644 --- a/src/promise.rs +++ b/src/promise.rs @@ -77,7 +77,7 @@ impl Promise { unsafe { v8__Promise__HasHandler(&*self) } } - /// Returns the content of the [[PromiseResult]] field. The Promise must not + /// Returns the content of the Promise Result. The Promise must not /// be pending. pub fn result<'s>(&self, scope: &mut HandleScope<'s>) -> Local<'s, Value> { unsafe { scope.cast_local(|_| v8__Promise__Result(&*self)) }.unwrap()