Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upRemove version info from Werkzeug in the docs #1852
Comments
This comment has been minimized.
This comment has been minimized.
|
@untitaker really not sure what to do here. Maybe there's a way to indicate the package as well as the version for externals we're re-documenting? Or disable the versions in those cases? This came up while looking at #1704. |
This comment has been minimized.
This comment has been minimized.
|
We should set a manual description for this function, and refer to Werkzeug docs (see intersphinx for that). Another reason for a necessary rephrasing is that "return a WSGI application" is unnecessarily low-level for Flask's docs, and only appropriate for Werkzeug's. |
This comment has been minimized.
This comment has been minimized.
|
Similar to how I wrote a plugin to collapse old version directives, maybe we can write a plugin that adds "Werkzeug version ...". That would be a lot more maintainable. |
This comment has been minimized.
This comment has been minimized.
|
I apologize if this is more general, but what level of technical detail is desired when writing Flask docs? I wouldn't consider mentioning WSGI to be low-level, but can understand if that's meant to be abstracted. |
This comment has been minimized.
This comment has been minimized.
|
I don't have a particular problem with how the API docs read currently. If we need to simplify something that can be done at a later time. |
The following version information is coming from the Werkzeug docs: "New in version 0.6: The location can now be a unicode string that is encoded using the iri_to_uri() function." See http://flask.pocoo.org/docs/0.11/api/#flask.redirect.
There might be more of this kind of issue in the documentation. For this particular one, you can trace the code to docs/api.rst,: