Skip to content

Commit 1791d09

Browse files
author
Arnaud Coomans
committed
Merge pull request #6 from wshayes/master
Fixes #4 - @auto.doc needs to be a function @auto.doc()
2 parents 74f4c5f + b39cd89 commit 1791d09

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ Start using Flask-Autodoc by importing it and initializing it:
1818

1919
from flask import Flask
2020
from flask.ext.autodoc import Autodoc
21-
21+
2222
app = Flask(__name__)
2323
auto = Autodoc(app)
2424

2525
by default, Flask-Autodoc will only document the routes you explicitly tell him to with the _doc_ decorator,
2626
like this:
27-
27+
2828
@app.route('/user/<int:id>')
29-
@auto.doc
29+
@auto.doc()
3030
def show_user(id):
3131
"""This returns a user with a given id."""
3232
return user_from_database(id)

0 commit comments

Comments
 (0)