Ver Fonte

Fix ReST formatting

shalvah há 5 anos atrás
pai
commit
a6f4212582
1 ficheiros alterados com 4 adições e 3 exclusões
  1. 4 3
      docs/documenting/documenting-api-information.md

+ 4 - 3
docs/documenting/documenting-api-information.md

@@ -5,9 +5,10 @@ You can add authentication information for your API using the `auth` section in
 
 ```eval_rst
 .. Important:: Scribe uses your specified authentication information in three places:
-- Generating an "Authentication" section in your docs
-- Adding authentication parameters to your example requests (only for endpoints marked as `@authenticated`)
-- Adding the necessary auth parameters with the specified value to response calls (only for endpoints marked as `@authenticated`)
+
+   - Generating an "Authentication" section in your docs
+   - Adding authentication parameters to your example requests (only for endpoints marked as `@authenticated`)
+   - Adding the necessary auth parameters with the specified value to response calls (only for endpoints marked as `@authenticated`)
 ```
 
 Here's how you'd configure auth with a query parameter named `apiKey`: