Added documentation for Biased and HtmlLorem provider

Bram Ceulemans · Bram Ceulemans · commit f293f4d699fc · 2020-11-18T18:15:08.000+01:00
diff --git a/docs/formatters.md b/docs/formatters.md
@@ -66,19 +66,3 @@ jobTitle                // 'Cashier'
 ```php
 realText($maxNbChars = 200, $indexSize = 2) // "And yet I wish you could manage it?) 'And what are they made of?' Alice asked in a shrill, passionate voice. 'Would YOU like cats if you were never even spoke to Time!' 'Perhaps not,' Alice replied."
 ```
-
-### `Faker\Provider\Biased`
-
-```php
-// get a random number between 10 and 20,
-// with more chances to be close to 20
-biasedNumberBetween($min = 10, $max = 20, $function = 'sqrt')
-```
-
-### `Faker\Provider\HtmlLorem`
-
-```php
-// Generate HTML document which is no more than 2 levels deep, and no more than 3 elements wide at any level.
-randomHtml(2, 3)   
-// <html><head><title>Aut illo dolorem et accusantium eum.</title></head><body><form action="example.com" method="POST"><label for="username">sequi</label><input type="text" id="username"><label for="password">et</label><input type="password" id="password"></form><b>Id aut saepe non mollitia voluptas voluptas.</b><table><thead><tr><tr>Non consequatur.</tr><tr>Incidunt est.</tr><tr>Aut voluptatem.</tr><tr>Officia voluptas rerum quo.</tr><tr>Asperiores similique.</tr></tr></thead><tbody><tr><td>Sapiente dolorum dolorem sint laboriosam commodi qui.</td><td>Commodi nihil nesciunt eveniet quo repudiandae.</td><td>Voluptates explicabo numquam distinctio necessitatibus repellat.</td><td>Provident ut doloremque nam eum modi aspernatur.</td><td>Iusto inventore.</td></tr><tr><td>Animi nihil ratione id mollitia libero ipsa quia tempore.</td><td>Velit est officia et aut tenetur dolorem sed mollitia expedita.</td><td>Modi modi repudiandae pariatur voluptas rerum ea incidunt non molestiae eligendi eos deleniti.</td><td>Exercitationem voluptatibus dolor est iste quod molestiae.</td><td>Quia reiciendis.</td></tr><tr><td>Inventore impedit exercitationem voluptatibus rerum cupiditate.</td><td>Qui.</td><td>Aliquam.</td><td>Autem nihil aut et.</td><td>Dolor ut quia error.</td></tr><tr><td>Enim facilis iusto earum et minus rerum assumenda quis quia.</td><td>Reprehenderit ut sapiente occaecati voluptatum dolor voluptatem vitae qui velit.</td><td>Quod fugiat non.</td><td>Sunt nobis totam mollitia sed nesciunt est deleniti cumque.</td><td>Repudiandae quo.</td></tr><tr><td>Modi dicta libero quisquam doloremque qui autem.</td><td>Voluptatem aliquid saepe laudantium facere eos sunt dolor.</td><td>Est eos quis laboriosam officia expedita repellendus quia natus.</td><td>Et neque delectus quod fugit enim repudiandae qui.</td><td>Fugit soluta sit facilis facere repellat culpa magni voluptatem maiores tempora.</td></tr><tr><td>Enim dolores doloremque.</td><td>Assumenda voluptatem eum perferendis exercitationem.</td><td>Quasi in fugit deserunt ea perferendis sunt nemo consequatur dolorum soluta.</td><td>Maxime repellat qui numquam voluptatem est modi.</td><td>Alias rerum rerum hic hic eveniet.</td></tr><tr><td>Tempore voluptatem.</td><td>Eaque.</td><td>Et sit quas fugit iusto.</td><td>Nemo nihil rerum dignissimos et esse.</td><td>Repudiandae ipsum numquam.</td></tr><tr><td>Nemo sunt quia.</td><td>Sint tempore est neque ducimus harum sed.</td><td>Dicta placeat atque libero nihil.</td><td>Et qui aperiam temporibus facilis eum.</td><td>Ut dolores qui enim et maiores nesciunt.</td></tr><tr><td>Dolorum totam sint debitis saepe laborum.</td><td>Quidem corrupti ea.</td><td>Cum voluptas quod.</td><td>Possimus consequatur quasi dolorem ut et.</td><td>Et velit non hic labore repudiandae quis.</td></tr></tbody></table></body></html>
-```
diff --git a/docs/formatters/biased.md b/docs/formatters/biased.md
@@ -0,0 +1,21 @@
+# Biased
+
+## `biasedNumberBetween`
+
+Generate a random `integer`, with a bias using a given function.
+
+```php
+function biasedNumberBetween(int $min = 0, int $max = 100, string $function = 'sqrt'): int;
+```
+
+Examples:
+
+```php
+echo $faker->biasedNumberBetween(0, 20);
+
+// 14, 18, 12
+
+echo $faker->biasedNumberBetween(0, 20, 'log');
+
+// 9, 4, 12
+```
diff --git a/docs/formatters/html-lorem.md b/docs/formatters/html-lorem.md
@@ -0,0 +1,19 @@
+# HTML Lorem
+
+## `htmlLorem`
+
+Generate a random HTML `string`, with a given maximum depth and width. By default, the depth and width are `4`.
+
+Depth defines the maximum depth of the body.
+
+Width defines the maximum of siblings each element can have.
+
+```php
+echo $faker->randomHtml();
+
+// '<html><head><title>Laborum doloribus voluptatum vitae quia voluptatum ipsum veritatis.</title></head><body><form action="example.org" method="POST"><label for="username">sit</label><input type="text" id="username"><label for="password">amet</label><input type="password" id="password"></form><div class="et"><span>Numquam magnam.</span><p>Neque facere consequuntur autem quisquam.</p><ul><li>Veritatis sint.</li><li>Et ducimus.</li><li>Veniam accusamus cupiditate.</li><li>Eligendi eum et doloribus.</li><li>Voluptate ipsa dolores est.</li><li>Enim.</li><li>Dignissimos nostrum atque et excepturi.</li><li>Nisi veniam.</li><li>Voluptate nihil labore sapiente.</li><li>Ut.</li><li>Id suscipit.</li></ul><i>Qui tempora minima ad.</i></div></body></html>'
+
+echo $faker->randomHtml(1, 1);
+
+// '<html><head><title>Architecto ut eius nisi molestiae atque ab.</title></head><body><form action="example.net" method="POST"><label for="username">saepe</label><input type="text" id="username"><label for="password">est</label><input type="password" id="password"></form></body></html>'
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -97,6 +97,8 @@ nav:
       - formatters/uuid.md
       - formatters/barcode.md
       - formatters/miscellaneous.md
+      - formatters/biased.md
+      - formatters/html-lorem.md
   - 'Locales': *locales
   - third-party.md
 
