Documentation: introduce clickable copy to clipboard headers for all pages and a hx-tags (#729)

jheinath · web-flow · commit 0a223b9615e8 · 2023-09-09T14:42:17.000+10:00
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -56,4 +56,4 @@ DEPENDENCIES
   ruby_dep (~> 1.3)
 
 BUNDLED WITH
-   1.17.2
+   1.17.2
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -4,6 +4,7 @@
   <meta charset="utf-8" />
   <title>NSubstitute: {{ page.title }}</title>
   <link rel="stylesheet" href="/css/style.css" type="text/css" />
+  <script src="{{ base.url | prepend: site.url }}/js/scripts.js"></script>
 </head>
 <body>
   <div id="header">
diff --git a/docs/css/style.css b/docs/css/style.css
@@ -1,25 +1,25 @@
 ﻿html { font-family: "helvetica", Helvetica, Arial }
 body {
-    margin:0;
-    padding:0;
-    border:0;
-    width:100%;
-    min-width:600px;
+    margin: 0;
+    padding: 0;
+    border: 0;
+    width: 100%;
+    min-width: 600px;
 }
 
-p{
-  font-size:1.0em;
-  line-height:1.6;
+p {
+  font-size: 1.0em;
+  line-height: 1.6;
 }
 
 ul {
-  font-size:1.0em;
-  line-height:1.6;
+  font-size: 1.0em;
+  line-height: 1.6;
 }
 
-h1{font-size:2.5em}
-h2{font-size:2.0em}
-h3{font-size:1.5em}
+h1{font-size: 2.5em}
+h2{font-size: 2.0em}
+h3{font-size: 1.5em}
 
 a:link { color: #365f91; text-decoration: none;}
 a:visited { color: #365f91; text-decoration: none;}
@@ -80,7 +80,7 @@ a:active { color: #000000; text-decoration: underline;}
 #post-content {
     float: left;
     position: relative;
-    width:71%;
+    width: 71%;
     padding-left: 10px;
 }
 
@@ -181,6 +181,42 @@ code {
     min-height: inherit !important;
 }
 
+h1 {
+    margin-top: 0.5em;
+    margin-bottom: 0.2em;
+}
+
+h2 {
+    position: relative;
+    display: inline-block;
+    margin-top: 0.5em;
+    margin-bottom: 0.2em;
+}
+
+h3 {
+    position: relative;
+    display: inline-block;
+    margin-top: 0.5em;
+    margin-bottom: 0.2em;
+}
+  
+.tooltip {
+    visibility: visible;
+    color: #365f91;
+    background-color: #ECF0F5;
+    position: absolute;
+    z-index: 1;
+    white-space: nowrap;
+    font-size: 0.4em;
+    padding: 0.6em;
+    margin: 0.4em auto auto 0.6em;
+    border-radius: 30px;
+}
+
+.tooltip-hidden {
+    visibility: hidden;
+}
+
 /* Pygments vs style, as generated by:
  *  https://github.com/richleland/pygments-css/blob/master/vs.css
  */
@@ -222,4 +258,4 @@ code {
 .highlight .sr { color: #a31515 } /* Literal.String.Regex */
 .highlight .s1 { color: #a31515 } /* Literal.String.Single */
 .highlight .ss { color: #a31515 } /* Literal.String.Symbol */
-/* End pygments vs style */
+/* End pygments vs style */
diff --git a/docs/help/_posts/2010-01-01-getting-started.markdown b/docs/help/_posts/2010-01-01-getting-started.markdown
@@ -119,4 +119,4 @@ calculator.PoweringUp += Raise.Event();
 Assert.That(eventWasRaised);
 ```
 
-That's pretty much all you need to get started with NSubstitute. Read on for more detailed feature descriptions, as well as for some of the less common requirements that NSubstitute supports.
+That's pretty much all you need to get started with NSubstitute. Read on for more detailed feature descriptions, as well as for some of the less common requirements that NSubstitute supports.
diff --git a/docs/help/_posts/2010-01-02-creating-a-substitute.markdown b/docs/help/_posts/2010-01-02-creating-a-substitute.markdown
@@ -98,7 +98,4 @@ Assert.AreEqual("hello", func());
 
 ## Partial substitutes and test spies
 
-When required we can also create substitutes that run real code by default, letting us replace [specific parts of a class with substitute behaviour](/help/partial-subs/).
-
-
-
+When required we can also create substitutes that run real code by default, letting us replace [specific parts of a class with substitute behaviour](/help/partial-subs/).
diff --git a/docs/help/_posts/2010-02-01-set-return-value.markdown b/docs/help/_posts/2010-02-01-set-return-value.markdown
@@ -52,5 +52,4 @@ Assert.AreEqual(calculator.Mode, "HEX");
 
 
 ## More ways of setting return values
-This covers the very basics of setting a return value, but NSubstitute can do much more. Read on for other approachs, including [matching specific arguments](/help/return-for-args), [ignoring arguments](/help/return-for-any-args), using [functions to calculate return values](/help/return-from-function) and returning [multiple results](/help/multiple-returns).
-
+This covers the very basics of setting a return value, but NSubstitute can do much more. Read on for other approachs, including [matching specific arguments](/help/return-for-args), [ignoring arguments](/help/return-for-any-args), using [functions to calculate return values](/help/return-from-function) and returning [multiple results](/help/multiple-returns).
diff --git a/docs/help/_posts/2010-02-02-return-for-args.markdown b/docs/help/_posts/2010-02-02-return-for-args.markdown
@@ -31,5 +31,4 @@ Assert.AreNotEqual(345, calculator.Add(1, 2));
 //Return when both args equal to 0:
 calculator.Add(Arg.Is(0), Arg.Is(0)).Returns(99);
 Assert.AreEqual(99, calculator.Add(0, 0));
-```
-
+```
diff --git a/docs/help/_posts/2010-02-03-return-for-any-args.markdown b/docs/help/_posts/2010-02-03-return-for-any-args.markdown
@@ -30,4 +30,4 @@ calculator.Add(default, default).ReturnsForAnyArgs(100);
 
 The same behaviour can also be achieved using [argument matchers](/help/argument-matchers): it is simply a shortcut for replacing each argument with `Arg.Any<T>()`.
 
-`ReturnsForAnyArgs()` has the same overloads as `Returns()`, so you can also specify multiple return values or calculated return values using this approach.
+`ReturnsForAnyArgs()` has the same overloads as `Returns()`, so you can also specify multiple return values or calculated return values using this approach.
diff --git a/docs/help/_posts/2010-02-03-return-from-function.markdown b/docs/help/_posts/2010-02-03-return-from-function.markdown
@@ -79,4 +79,4 @@ calculator
 calculator.Add(7,3);
 calculator.Add(2,2);
 Assert.AreEqual(counter, 2);
-```
+```
diff --git a/docs/help/_posts/2010-02-04-multiple-returns.markdown b/docs/help/_posts/2010-02-04-multiple-returns.markdown
@@ -38,5 +38,4 @@ Assert.Throws<Exception>(() => { var result = calculator.Mode; });
 
 ## Configuring other calls without using up multiple returns
 
-If a call has been configured with multiple returns values, you can configure a more specific call without using up any of these callbacks using [`.Configure()`](/help/configure/).
-
+If a call has been configured with multiple returns values, you can configure a more specific call without using up any of these callbacks using [`.Configure()`](/help/configure/).
diff --git a/docs/help/_posts/2010-02-10-replacing-return-values.markdown b/docs/help/_posts/2010-02-10-replacing-return-values.markdown
@@ -23,5 +23,4 @@ public void SetUp() {
     calculator = Substitute.For<ICalculator>();
 }
 ```
--->
-
+-->
diff --git a/docs/help/_posts/2010-03-01-received-calls.markdown b/docs/help/_posts/2010-03-01-received-calls.markdown
@@ -237,5 +237,4 @@ public void ShouldRaiseLowFuel(){
 	    .Received()
 	    .Invoke(fuelManagement, Arg.Is<LowFuelWarningEventArgs>(x => x.PercentLeft < 20));
 }
-``` 
-
+``` 
diff --git a/docs/help/_posts/2010-03-10-clear-received-calls.markdown b/docs/help/_posts/2010-03-10-clear-received-calls.markdown
@@ -43,6 +43,4 @@ runner.Run();
 command.DidNotReceive().Execute();
 ```
 
-`ClearReceivedCalls()` will not clear any results set up for the substitute using `Returns()`. If we need to this, we can [replace previously specified results](/help/replacing-return-values) by calling `Returns()` again.
-
-
+`ClearReceivedCalls()` will not clear any results set up for the substitute using `Returns()`. If we need to this, we can [replace previously specified results](/help/replacing-return-values) by calling `Returns()` again.
diff --git a/docs/help/_posts/2010-04-01-argument-matchers.markdown b/docs/help/_posts/2010-04-01-argument-matchers.markdown
@@ -293,4 +293,4 @@ public void ManualArgSnapshot() {
 }
 ```
 
- We can then use our standard assertion library for checking the value. This approach can also be helpful for asserting on complex objects, as our assertions can be more detailed and provide more useful information than NSubstitute typically provides in these cases.
+ We can then use our standard assertion library for checking the value. This approach can also be helpful for asserting on complex objects, as our assertions can be more detailed and provide more useful information than NSubstitute typically provides in these cases.
diff --git a/docs/help/_posts/2010-05-01-callbacks.markdown b/docs/help/_posts/2010-05-01-callbacks.markdown
@@ -111,5 +111,4 @@ for (int i = 0; i < 5; i++)
 }
 Assert.That(String.Concat(calls), Is.EqualTo("123++"));
 Assert.That(counter, Is.EqualTo(5));
-```
-
+```
diff --git a/docs/help/_posts/2010-05-02-throwing-exceptions.markdown b/docs/help/_posts/2010-05-02-throwing-exceptions.markdown
@@ -25,5 +25,4 @@ calculator
 //Both calls will now throw.
 Assert.Throws<Exception>(() => calculator.Add(-1, -1));
 Assert.Throws<Exception>(() => calculator.Add(-2, -2));
-```
-
+```
diff --git a/docs/help/_posts/2010-05-10-configure.markdown b/docs/help/_posts/2010-05-10-configure.markdown
@@ -32,4 +32,4 @@ Assert.Throws<Exception>(() => calculator.Add(-2, -2));
 
 NSubstitute will also assume we are configuring a call if we have an argument matcher in our call, such as `Arg.Is(1)` in `calculator.Add(Arg.Is(1), 2).Returns(3)`, but it is generally better to be more explicit by using `.Configure()`.
 
-This can be particularly useful with [partial substitutes](/help/partial-subs/) to help avoid real code being executed when configuring calls that would otherwise call the base implementation.
+This can be particularly useful with [partial substitutes](/help/partial-subs/) to help avoid real code being executed when configuring calls that would otherwise call the base implementation.
diff --git a/docs/help/_posts/2010-06-01-raising-events.markdown b/docs/help/_posts/2010-06-01-raising-events.markdown
@@ -95,4 +95,4 @@ engine.RevvedAt += rpm => revvedAt = rpm;
 engine.RevvedAt += Raise.Event<Action<int>>(123);
 
 Assert.AreEqual(123, revvedAt);
-```
+```
diff --git a/docs/help/_posts/2010-10-01-auto-and-recursive-mocks.markdown b/docs/help/_posts/2010-10-01-auto-and-recursive-mocks.markdown
@@ -103,9 +103,4 @@ Properties and methods returning types of `String` or `Array` will automatically
 var identity = Substitute.For<IIdentity>();
 Assert.AreEqual(String.Empty, identity.Name);
 Assert.AreEqual(0, identity.Roles().Length);
-```
-
-
-
-
-
+```
diff --git a/docs/help/_posts/2010-11-01-setting-out-and-ref-arguments.markdown b/docs/help/_posts/2010-11-01-setting-out-and-ref-arguments.markdown
@@ -56,5 +56,4 @@ Assert.AreEqual(1, counter);
 lookup.TryLookup("hello", out value);
 // Call does NOT match anymore, counter is still 1:
 Assert.AreEqual(1, counter);
-```
-
+```
diff --git a/docs/help/_posts/2010-12-01-actions-with-arguments.markdown b/docs/help/_posts/2010-12-01-actions-with-arguments.markdown
@@ -127,5 +127,4 @@ var results = new[] {
 
 Assert.AreEqual(3, numberOfCallsWhereFirstArgIsLessThan0); //3 of 4 calls have first arg < 0
 Assert.AreEqual(results, new[] {123, 123, 123, 0}); //Last call returns 0, not 123
-```
-
+```
diff --git a/docs/help/_posts/2013-01-01-received-in-order.markdown b/docs/help/_posts/2013-01-01-received-in-order.markdown
@@ -65,5 +65,4 @@ public interface ICommand {
   void Run(IConnection c);
 }
 ```
--->
-
+-->
diff --git a/docs/help/_posts/2013-02-01-partial-subs.markdown b/docs/help/_posts/2013-02-01-partial-subs.markdown
@@ -77,6 +77,4 @@ public void ShouldSendMultipleEmails() {
 
 ## Test spies
 
-Even without substituting for specific parts of a class, the instance returned by `Substitute.ForPartsOf<T>` records all calls made to virtual members, so we can [check `Received()` calls](/help/received-calls/) made to any partial substitute.
-
-
+Even without substituting for specific parts of a class, the instance returned by `Substitute.ForPartsOf<T>` records all calls made to virtual members, so we can [check `Received()` calls](/help/received-calls/) made to any partial substitute.
diff --git a/docs/help/_posts/2013-03-01-return-for-all.markdown b/docs/help/_posts/2013-03-01-return-for-all.markdown
@@ -84,4 +84,4 @@ public void ReturnsTakesPrecedence() {
   Assert.That(sub.GetWidget(1), Is.SameAs(widget));
   Assert.That(sub.GetWidget(42), Is.SameAs(otherWidget));
 }
-```
+```
diff --git a/docs/help/_posts/2013-04-01-threading.markdown b/docs/help/_posts/2013-04-01-threading.markdown
@@ -7,5 +7,4 @@ It is fairly standard for production code to call a substitute from multiple thr
 
 Although this particular issue has been mitigated by work in [#452](https://github.com/nsubstitute/NSubstitute/pull/462), issue [#256](https://github.com/nsubstitute/NSubstitute/issues/256) shows the types of problems that can occur if we're not careful with threading.
 
-To avoid this sort of problem, make sure your test has finished configuring its substitutes before exercising the production code, then make sure the production code has completed before your test asserts on `Received()` calls.
-
+To avoid this sort of problem, make sure your test has finished configuring its substitutes before exercising the production code, then make sure the production code has completed before your test asserts on `Received()` calls.
diff --git a/docs/help/_posts/2013-04-15-compat-args.markdown b/docs/help/_posts/2013-04-15-compat-args.markdown
@@ -115,6 +115,4 @@ public void Sample() {
     // Or re-write without expression tree if possible:
     sub.Received().DoStuff(Arg.Any<int>());
 }
-```
-
-
+```
diff --git a/docs/help/_posts/2013-05-01-nsubstitute-analysers.markdown b/docs/help/_posts/2013-05-01-nsubstitute-analysers.markdown
@@ -18,4 +18,4 @@ See [NSubstitute.Analyzers documentation](https://github.com/nsubstitute/NSubsti
 
 ## Spelling
 
-The Australian members of our team would like to point out they would have preferred to use the English spelling `NSubstitute.Analysers` for this project, but have begrudgingly agreed to use the American (mis)spelling instead. :)
+The Australian members of our team would like to point out they would have preferred to use the English spelling `NSubstitute.Analysers` for this project, but have begrudgingly agreed to use the American (mis)spelling instead. :)
diff --git a/docs/help/_posts/2015-01-01-how-nsub-works.markdown b/docs/help/_posts/2015-01-01-how-nsub-works.markdown
@@ -86,6 +86,4 @@ The final thing to notice here is that there is the potential for real logic fro
 * Be careful substituting for classes!
 * Where possible use interfaces instead.
 * Remember NSubstitute works by inheriting from (or implementing) your original type. If you can't override a member by manually writing a sub-class, then NSubstitute won't be able to either!
-* Install [NSubstitute.Analyzers](/help/nsubstitute-analysers) where ever you install NSubstitute. This will help you avoid these (and other) pitfalls.
-
-
+* Install [NSubstitute.Analyzers](/help/nsubstitute-analysers) where ever you install NSubstitute. This will help you avoid these (and other) pitfalls.
diff --git a/docs/index.md b/docs/index.md
@@ -5,7 +5,8 @@ title: A friendly substitute for .NET mocking libraries
 
 <div id="features">
 <div class="feature" markdown="1">
-<h2>Simple, succinct, pleasant to use</h2>
+
+## Simple, succinct, pleasant to use
 
 ```csharp
 //Create:
@@ -35,8 +36,10 @@ calculator.PoweringUp += Raise.Event();
 -->
 </div>
 
-<div class="feature">
-<h2>Helpful exceptions</h2>
+<div class="feature" markdown="1">
+
+## Helpful exceptions
+
 <div class="highlight">
 <pre>
 ReceivedCallsException : Expected to receive a call matching:
@@ -48,8 +51,10 @@ Received 2 non-matching calls (non-matching arguments indicated with '*' charact
 </div>
 </div>
 
-<div class="feature">
-<h2>Don't sweat the small stuff</h2>
+<div class="feature" markdown="1">
+
+## Don't sweat the small stuff
+
 <p>Mock, stub, fake, spy, test double? Strict or loose? Nah, just substitute for the type you need!</p>
 <p>NSubstitute is designed for Arrange-Act-Assert (AAA) testing, so you just need to arrange how it should work, then assert it received the calls you expected once you're done. Because you've got more important code to write than whether you need a mock or a stub.</p>
 </div>
@@ -74,8 +79,9 @@ Received 2 non-matching calls (non-matching arguments indicated with '*' charact
 </div>
 
 <div class="sidebar">
-<div id="why-use-it">
-<h3>Another library?</h3>
+<div id="why-use-it" markdown="1">
+
+### Another library?
 
 <p>There are already some great mocking libraries around for .NET, so why create another? We found that for all their great features, none of the existing libraries had the succinct syntax we were craving &mdash; the code required to configure test doubles quickly obscured the intention behind our tests.</p>
 
diff --git a/docs/js/scripts.js b/docs/js/scripts.js

Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ calculator.Add(default, default).ReturnsForAnyArgs(100);`
`30`	`30`
`31`	`31`	The same behaviour can also be achieved using [argument matchers](/help/argument-matchers): it is simply a shortcut for replacing each argument with `Arg.Any<T>()`.
`32`	`32`
`33`		-`ReturnsForAnyArgs()` has the same overloads as `Returns()`, so you can also specify multiple return values or calculated return values using this approach.
	`33`	+`ReturnsForAnyArgs()` has the same overloads as `Returns()`, so you can also specify multiple return values or calculated return values using this approach.
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,4 @@ public void SetUp() {`
`23`	`23`	`calculator = Substitute.For<ICalculator>();`
`24`	`24`	`}`
`25`	`25`	```
`26`		`--->`
`27`		`-`
	`26`	`+-->`
Original file line number	Diff line number	Diff line change
`@@ -237,5 +237,4 @@ public void ShouldRaiseLowFuel(){`
`237`	`237`	`.Received()`
`238`	`238`	`.Invoke(fuelManagement, Arg.Is<LowFuelWarningEventArgs>(x => x.PercentLeft < 20));`
`239`	`239`	`}`
`240`		-```
`241`		`-`
	`240`	+```
Original file line number	Diff line number	Diff line change
`@@ -293,4 +293,4 @@ public void ManualArgSnapshot() {`
`293`	`293`	`}`
`294`	`294`	```
`295`	`295`
`296`		`- We can then use our standard assertion library for checking the value. This approach can also be helpful for asserting on complex objects, as our assertions can be more detailed and provide more useful information than NSubstitute typically provides in these cases.`
	`296`	`+ We can then use our standard assertion library for checking the value. This approach can also be helpful for asserting on complex objects, as our assertions can be more detailed and provide more useful information than NSubstitute typically provides in these cases.`
Original file line number	Diff line number	Diff line change
`@@ -111,5 +111,4 @@ for (int i = 0; i < 5; i++)`
`111`	`111`	`}`
`112`	`112`	`Assert.That(String.Concat(calls), Is.EqualTo("123++"));`
`113`	`113`	`Assert.That(counter, Is.EqualTo(5));`
`114`		-```
`115`		`-`
	`114`	+```
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,4 @@ Assert.Throws<Exception>(() => calculator.Add(-2, -2));`
`32`	`32`
`33`	`33`	NSubstitute will also assume we are configuring a call if we have an argument matcher in our call, such as `Arg.Is(1)` in `calculator.Add(Arg.Is(1), 2).Returns(3)`, but it is generally better to be more explicit by using `.Configure()`.
`34`	`34`
`35`		`-This can be particularly useful with [partial substitutes](/help/partial-subs/) to help avoid real code being executed when configuring calls that would otherwise call the base implementation.`
	`35`	`+This can be particularly useful with [partial substitutes](/help/partial-subs/) to help avoid real code being executed when configuring calls that would otherwise call the base implementation.`
Original file line number	Diff line number	Diff line change
`@@ -65,5 +65,4 @@ public interface ICommand {`
`65`	`65`	`void Run(IConnection c);`
`66`	`66`	`}`
`67`	`67`	```
`68`		`--->`
`69`		`-`
	`68`	`+-->`
Original file line number	Diff line number	Diff line change
`@@ -84,4 +84,4 @@ public void ReturnsTakesPrecedence() {`
`84`	`84`	`Assert.That(sub.GetWidget(1), Is.SameAs(widget));`
`85`	`85`	`Assert.That(sub.GetWidget(42), Is.SameAs(otherWidget));`
`86`	`86`	`}`
`87`		-```
	`87`	+```
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,4 @@ public void Sample() {`
`115`	`115`	`// Or re-write without expression tree if possible:`
`116`	`116`	`sub.Received().DoStuff(Arg.Any<int>());`
`117`	`117`	`}`
`118`		-```
`119`		`-`
`120`		`-`
	`118`	+```
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,4 @@ See [NSubstitute.Analyzers documentation](https://github.com/nsubstitute/NSubsti`
`18`	`18`
`19`	`19`	`## Spelling`
`20`	`20`
`21`		-The Australian members of our team would like to point out they would have preferred to use the English spelling `NSubstitute.Analysers` for this project, but have begrudgingly agreed to use the American (mis)spelling instead. :)
	`21`	+The Australian members of our team would like to point out they would have preferred to use the English spelling `NSubstitute.Analysers` for this project, but have begrudgingly agreed to use the American (mis)spelling instead. :)