Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify all imports in examples #147

Open
PetrDlouhy opened this issue Jun 24, 2020 · 1 comment
Open

Specify all imports in examples #147

PetrDlouhy opened this issue Jun 24, 2020 · 1 comment

Comments

@PetrDlouhy
Copy link

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.

@niall-byrne
Copy link
Collaborator

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants