Skip to content

Add more docs #47

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

Closed
dbanty opened this issue May 19, 2020 · 3 comments
Closed

Add more docs #47

dbanty opened this issue May 19, 2020 · 3 comments
Labels
📝 documentation Improvements or additions to documentation

Comments

@dbanty
Copy link
Collaborator

dbanty commented May 19, 2020

README does its best to explain what you get in concise terms. It would probably be nicer to have a more expressive reference doc which walks through most of the things you could need to do with your generated client.

@dbanty dbanty added the ✨ enhancement New feature or improvement label May 19, 2020
@dbanty dbanty added 📝 documentation Improvements or additions to documentation and removed ✨ enhancement New feature or improvement labels Nov 18, 2020
@synchronizing
Copy link

Generated README also needs to be updated. async methods are documented as:

from <project>_client.async_api.my_tag import get_my_data_model
...
get_my_data_model.asyncio(...)

Where it should (likely be, for the example):

from <project>_client.api.my_tag import get_my_data_model
...
get_my_data_model.asyncio(...)

@dbanty
Copy link
Collaborator Author

dbanty commented Feb 10, 2021

Thanks for reporting the issue @synchronizing ! It will be fixed with #337

@dbanty
Copy link
Collaborator Author

dbanty commented Aug 13, 2023

This issue has always been too broad, which is why it's never been completed 😞. I'm going to close it, and we can track any specific docs goals in the future.

@dbanty dbanty closed this as not planned Won't fix, can't repro, duplicate, stale Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants