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

[Epic] Better documentation #836

Open
8 of 9 tasks
shin- opened this issue Nov 3, 2015 · 4 comments
Open
8 of 9 tasks

[Epic] Better documentation #836

shin- opened this issue Nov 3, 2015 · 4 comments

Comments

@shin-
Copy link
Contributor

shin- commented Nov 3, 2015

Main takeaways:

  • API docs are poorly formatted and difficult to navigate.
  • Some users find it valuable to have the documentation closer to the code itself.
  • More information could be given about the behavior of our methods (exceptions raised, etc.)
  • User guides in addition to functional documentation could prove useful.
@shin- shin- self-assigned this Nov 3, 2015
@shin- shin- added this to the 1.6.0 milestone Nov 3, 2015
@dnephin
Copy link
Contributor

dnephin commented Nov 3, 2015

If I could add one more point, I think it would be awesome to have a link from the docker-py docs to the official API for the endpoint as well.

@shin-
Copy link
Contributor Author

shin- commented Nov 3, 2015

I didn't think of that, but you're right. Noting this down!

@shin- shin- modified the milestones: 1.6.0, 1.7.0 Nov 18, 2015
@shin- shin- modified the milestones: 1.7.0, 1.8.0 Jan 28, 2016
@shin- shin- modified the milestones: 1.8.0, 1.9.0 Mar 23, 2016
@shin- shin- modified the milestone: 1.9.0 Jun 16, 2016
@bfirsh bfirsh changed the title [Master ticket] Better documentation [Epic] Better documentation Nov 28, 2016
@bfirsh
Copy link
Contributor

bfirsh commented Nov 28, 2016

I've added some check boxes to see how we're doing here! I think the only things left are:

huogerac added a commit to huogerac/docker-py that referenced this issue Jun 3, 2021
huogerac added a commit to huogerac/docker-py that referenced this issue Jun 3, 2021
…sue docker#836

Signed-off-by: Roger Camargo <huogerac@gmail.com>
@huogerac
Copy link
Contributor

huogerac commented Jun 9, 2021

Hello, I'd like to know if I did something wrong or miss something due to make my PR reviewed.
Cheers

mat007 added a commit that referenced this issue Jun 29, 2021
Update the Image.save documentation with a working example. Issue #836
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants