Skip to content
This repository is currently being migrated. It's locked while the migration is in progress.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
atlithorn committed Mar 18, 2015
1 parent 4c61773 commit c8e799b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class UserAPI(MethodView):
"""
return {}
```
Flask-swagger supports docstrings in methods of MethodView classes and regular Flask view functions.
Flask-swagger supports docstrings in methods of MethodView classes (ala [Flask-RESTful](https://github.com/flask-restful/flask-restful)) and regular Flask view functions.

Following YAML conventions, flask-swagger searches for `---`, everything preceding is provided as `summary` (first line) and `description` (following lines) for the endpoint while everything after is parsed as a swagger [Operation](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operation-object) object.

Expand Down

0 comments on commit c8e799b

Please sign in to comment.