Browse Source

Update docs

shalvah 5 years ago
parent
commit
d4b250f58d
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/documenting/documenting-endpoint-metadata.md

+ 4 - 0
docs/documenting/documenting-endpoint-metadata.md

@@ -22,6 +22,10 @@ becomes:
 
 
 ![](../images/endpoint-title-description.png)
 ![](../images/endpoint-title-description.png)
 
 
+```eval_rst
+.. Note:: If your first line doesn't end with a period (.), you'll have to leave a blank line before the description. Otherwise, both paragraphs would be parsed together as the title.
+```
+
 ## Grouping endpoints
 ## Grouping endpoints
 All endpoints are grouped for easy navigation.
 All endpoints are grouped for easy navigation.