Skip to content

Commit b39cd89

Browse files
committed
Fixes #4 - @auto.doc needs to be a function @auto.doc()
1 parent d4ed08e commit b39cd89

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
@@ -16,15 +16,15 @@ Start using Flask-Autodoc by importing it and initializing it:
1616

1717
from flask import Flask
1818
from flask.ext.autodoc import Autodoc
19-
19+
2020
app = Flask(__name__)
2121
auto = Autodoc(app)
2222

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

0 commit comments

Comments
 (0)