docs: Fix links and various other minor issues with the documentation (#908)

Author: eliassjogreen

nova_lint/src/no_it_performs_the_following.rs

@@ -10,11 +10,14 @@ use rustc_span::{BytePos, Span};
 dylint_linting::declare_early_lint! {
     /// ### What it does
     ///
-    /// This lint disallows doc comments that contain the phrase "It performs the following steps when called".
+    /// This lint disallows doc comments that contain the phrase
+    /// "It performs the following steps when called", or any variation of it
+    /// like: "This method performs the following steps when called".
     ///
     /// ### Why is this bad?
     ///
-    /// This phrase is a leftover from copy-pasting the TC-39 specification and does not add value to the documentation.
+    /// This phrase is a leftover from copy-pasting the TC-39 specification and
+    /// does not add value to the documentation.
     ///
     /// ### Example
     ///
@@ -47,9 +50,12 @@ dylint_linting::declare_early_lint! {
 }
 
 impl EarlyLintPass for NoItPerformsTheFollowing {
+    // TODO: This should check for multiline comments too, probably using the
+    // `check_attributes` method instead because each doc comment line is it's
+    // own attribute.
     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &Attribute) {
         static RE: LazyLock<Regex> = LazyLock::new(|| {
-            RegexBuilder::new(r"It performs the following steps when called:?")
+            RegexBuilder::new(r"(This method|It) performs the following steps when called:?")
                 .case_insensitive(true)
                 .build()
                 .unwrap()

nova_vm/src/ecmascript/abstract_operations/operations_on_objects.rs

@@ -1247,7 +1247,7 @@ pub(crate) fn construct<'a>(
         .internal_construct(agent, arguments_list, new_target.unbind(), gc)
 }
 
-/// ### [7.3.20 Invoke ( V, P \[ , argumentsList \] )]()
+/// ### [7.3.20 Invoke ( V, P \[ , argumentsList \] )](https://tc39.es/ecma262/#sec-invoke)
 ///
 /// The abstract operation Invoke takes arguments V (an ECMAScript language
 /// value) and P (a property key) and optional argument argumentsList (a List

nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_capability_records.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-//! ## [27.2.1.1 PromiseCapability Records]()
+//! ### [27.2.1.1 PromiseCapability Records](https://tc39.es/ecma262/#sec-promisecapability-records)
 
 use crate::{
     ecmascript::{
@@ -49,6 +49,7 @@ pub struct PromiseCapability<'a> {
 
 impl<'a> PromiseCapability<'a> {
     ///### [27.2.1.5 NewPromiseCapability ( C )](https://tc39.es/ecma262/#sec-newpromisecapability)
+    ///
     /// NOTE: Our implementation doesn't take C as a parameter, since we don't
     /// yet support promise subclassing.
     pub fn new(agent: &mut Agent, gc: NoGcScope<'a, '_>) -> Self {

nova_vm/src/ecmascript/builtins/control_abstraction_objects/promise_objects/promise_abstract_operations/promise_resolving_functions.rs

@@ -29,7 +29,7 @@ pub(crate) enum PromiseResolvingFunctionType {
     Reject,
 }
 
-/// ### [27.2.1.3.1 Promise Reject Functions]()
+/// ### [27.2.1.3.1 Promise Reject Functions](https://tc39.es/ecma262/#sec-promise-reject-functions)
 ///
 /// A promise reject function is an anonymous built-in function that has
 /// \[\[Promise\]\] and \[\[AlreadyResolved\]\] internal slots.

nova_vm/src/ecmascript/builtins/indexed_collections/array_objects/array_prototype.rs

@@ -1229,7 +1229,7 @@ impl ArrayPrototype {
         Ok(Number::try_from(find_rec.0).unwrap().into_value())
     }
 
-    /// ### [23.1.3.13 Array.prototype.flat ( \[ depth \] )]()
+    /// ### [23.1.3.13 Array.prototype.flat ( \[ depth \] )](https://tc39.es/ecma262/#sec-array.prototype.flat)
     fn flat<'gc>(
         agent: &mut Agent,
         this_value: Value,

nova_vm/src/ecmascript/builtins/keyed_collections/weak_map_objects/weak_map_constructor.rs

@@ -36,7 +36,7 @@ impl BuiltinIntrinsicConstructor for WeakMapConstructor {
 }
 
 impl WeakMapConstructor {
-    /// ### [24.3.1.1 WeakMap ( \[ iterable \] )]()
+    /// ### [24.3.1.1 WeakMap ( \[ iterable \] )](https://tc39.es/ecma262/#sec-weakmap-iterable)
     ///
     /// > NOTE: If the parameter _iterable_ is present, it is expected to be an
     /// > object that implements a %Symbol.iterator% method that returns an

nova_vm/src/ecmascript/builtins/managing_memory/weak_ref_objects/weak_ref_prototype.rs

@@ -23,7 +23,7 @@ impl Builtin for WeakRefPrototypeDeref {
 }
 
 impl WeakRefPrototype {
-    /// ### [26.1.3.2 WeakRef.prototype.deref ( )]()
+    /// ### [26.1.3.2 WeakRef.prototype.deref ( )](https://tc39.es/ecma262/#sec-weak-ref.prototype.deref)
     fn deref<'gc>(
         agent: &mut Agent,
         this_value: Value,

nova_vm/src/ecmascript/builtins/regexp/abstract_operations.rs

@@ -43,7 +43,7 @@ use crate::{
 
 use super::{RegExp, RegExpHeapData, data::RegExpLastIndex};
 
-/// ### [22.2.3.1 RegExpCreate ( P, F )]()
+/// ### [22.2.3.1 RegExpCreate ( P, F )](https://tc39.es/ecma262/#sec-regexpcreate)
 ///
 /// The abstract operation RegExpCreate takes arguments P (an ECMAScript
 /// language value) and F (a String or undefined) and returns either a normal
@@ -63,7 +63,7 @@ pub(crate) fn reg_exp_create<'a>(
     reg_exp_initialize(agent, obj.unbind(), p, f, gc)
 }
 
-/// ### [22.2.3.1 RegExpCreate ( P, F )]()
+/// ### [22.2.3.1 RegExpCreate ( P, F )](https://tc39.es/ecma262/#sec-regexpcreate)
 ///
 /// The abstract operation RegExpCreate takes arguments P (an ECMAScript
 /// language value) and F (a String or undefined) and returns either a normal
@@ -83,7 +83,7 @@ pub(crate) fn reg_exp_create_literal<'a>(
     agent.heap.create(RegExpHeapData::new(agent, p, f)).bind(gc)
 }
 
-/// ### [22.2.3.2 RegExpAlloc ( newTarget )]()
+/// ### [22.2.3.2 RegExpAlloc ( newTarget )](https://tc39.es/ecma262/#sec-regexpalloc)
 ///
 /// The abstract operation RegExpAlloc takes argument newTarget (a constructor)
 /// and returns either a normal completion containing an Object or a throw
@@ -106,7 +106,7 @@ pub(crate) fn reg_exp_alloc<'a>(
     Ok(obj)
 }
 
-/// ### [22.2.3.3 RegExpInitialize ( obj, pattern, flags )]()
+/// ### [22.2.3.3 RegExpInitialize ( obj, pattern, flags )](https://tc39.es/ecma262/#sec-regexpinitialize)
 ///
 /// The abstract operation RegExpInitialize takes arguments obj (an Object),
 /// pattern (an ECMAScript language value), and flags (an ECMAScript language

nova_vm/src/ecmascript/builtins/text_processing/regexp_objects/regexp_constructor.rs

@@ -180,7 +180,7 @@ impl RegExpConstructor {
         reg_exp_initialize(agent, o.unbind(), p, f, gc).map(|o| o.into_value())
     }
 
-    /// ### [22.2.5.1 RegExp.escape ( S )]()
+    /// ### [22.2.5.1 RegExp.escape ( S )](https://tc39.es/ecma262/#sec-regexp.escape)
     ///
     /// This function returns a copy of S in which characters that are
     /// potentially special in a regular expression Pattern have been replaced

nova_vm/src/ecmascript/builtins/text_processing/string_objects/string_prototype.rs

@@ -1022,7 +1022,7 @@ impl StringPrototype {
         Ok(Value::Boolean(s.as_str(agent).is_some()))
     }
 
-    /// ### [22.1.3.11 String.prototype.lastIndexOf ( searchString \[ , position \] )]()
+    /// ### [22.1.3.11 String.prototype.lastIndexOf ( searchString \[ , position \] )](https://tc39.es/ecma262/#sec-string.prototype.lastindexof)
     ///
     /// > NOTE 1: If _searchString_ appears as a substring of the result of
     /// > converting this object to a String at one or more indices that are