flask-restful-swagger icon indicating copy to clipboard operation
flask-restful-swagger copied to clipboard

Specify all imports in examples

Open PetrDlouhy opened this issue 4 years ago • 1 comments

I am trying to understand how to use flask-restful-swagger, but I really struggle with the README (only documentation, that I found). One of the reasons is, that many imports are missing in the examples. I don't know where classes like marshal_with, fields came from.

Please add imports to the examples.

PetrDlouhy avatar Jun 24 '20 08:06 PetrDlouhy

Hi @PetrDlouhy, thanks for taking the time to file an issue.

marshal_with, and fields come directly from flask-restful, and not this package. Here is the relevant documentation: https://flask-restful.readthedocs.io/en/latest/api.html

Your point about explicitly adding the imports is a good one however.

I can certainly take a stab it, but please feel free to fork the repo and submit a PR for any documentation you think should be updated!

niall-byrne avatar Jul 07 '20 20:07 niall-byrne