route / add_url_rule Documentation #279

Closed
mitsuhiko opened this Issue Jul 14, 2011 · 3 comments

Comments

Projects
None yet
2 participants
Owner

mitsuhiko commented Jul 14, 2011

The docs are kinda inconsistent between route() and add_url_rule. The former should be documented as a decorator version of the latter which is true since Flask 0.3 at least.

Also with 0.7 and 0.8 we have some attributes on view functions that can have meanings attached. These now have a separate headline in the API docs, but I guess it would make sense to tidy this up a bit.

Poincare commented Aug 8, 2011

I don't think I quite understand you. In the documentation, it clearly shows an example of the difference between route() (as a decorator) and add_url_rule as a function, or, am I missing something?

Owner

mitsuhiko commented Aug 8, 2011

It does, but both accept the same options and they are inconsistently mentioned. One should be documented as invoking the other (which is what happens) and that both accept the same options.

Poincare commented Aug 8, 2011

Oh, okay.

On Mon, Aug 8, 2011 at 4:05 AM, mitsuhiko <
reply@reply.github.com>wrote:

It does, but both accept the same options and they are inconsistently
mentioned. One should be documented as invoking the other (which is what
happens) and that both accept the same options.

Reply to this email directly or view it on GitHub:
mitsuhiko#279 (comment)

@mitsuhiko mitsuhiko closed this in df1dd57 Sep 25, 2011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment