Browse Source

Update docs

shalvah 4 years ago
parent
commit
ff55287aed
4 changed files with 4 additions and 4 deletions
  1. 1 1
      README.md
  2. 1 1
      docs/migrating-v2.md
  3. 1 1
      src/Tools/WritingUtils.php
  4. 1 1
      src/Writing/Writer.php

+ 1 - 1
README.md

@@ -5,7 +5,7 @@
 </p>
 
 > Still on v1? Here's the [v2 migration guide](https://scribe.rtfd.io/en/latest/migrating-v2.html).
->
+
 Generate API documentation for humans from your Laravel codebase. [Here's what the output looks like](https://shalvah.me/TheCensorshipAPI/).
 
 [![Latest Stable Version](https://poser.pugx.org/knuckleswtf/scribe/v/stable)](https://packagist.org/packages/knuckleswtf/scribe) [![Total Downloads](https://poser.pugx.org/knuckleswtf/scribe/downloads)](https://packagist.org/packages/knuckleswtf/scribe) [![Build Status](https://travis-ci.com/knuckleswtf/scribe.svg?branch=master)](https://travis-ci.com/knuckleswtf/scribe)

+ 1 - 1
docs/migrating-v2.md

@@ -2,7 +2,7 @@
 
 Scribe 2 comes with a bunch of changes focused on making the documentation process easier and the output nicer. There aren't many "shiny" changes, mostly improvements to what works. We've marked required changes in the list below with a "Migration Required" label.
 
-This is also a release announcement for Scribe for JS! [Version 1 is now in beta](https://github.com/knuckleswtf/scribe-js) !🎉 
+This is also a release announcement for Scribe for JS! [Version 1 is now in out!](https://github.com/knuckleswtf/scribe-js) 🎉 
 
 ```eval_rst
 .. contents:: 

+ 1 - 1
src/Tools/WritingUtils.php

@@ -131,7 +131,7 @@ class WritingUtils
             return [$parameter.'[]' => $value[0]];
         }
 
-        // Transform maps
+        // Transform hashes
         $params = [];
         foreach ($value as $item => $itemValue) {
             if (is_array($itemValue)) {

+ 1 - 1
src/Writing/Writer.php

@@ -372,7 +372,7 @@ class Writer
                     $authDescription .= sprintf('a **`%s`** header with the value **`"%s"`**.', $parameterName, $this->config->get('auth.placeholder') ?: 'your-token');
                     break;
             }
-            $authDescription .= '\n\nAll authenticated endpoints are marked with a **requires authentication** badge in the documentation below.';
+            $authDescription .= '\n\nAll authenticated endpoints are marked with a `requires authentication` badge in the documentation below.';
             $extraInfo = $this->config->get('auth.extra_info', '');
         }