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

Documentation improvements #329

Merged
merged 8 commits into from Jan 11, 2018

Conversation

3 participants
@mjs
Owner

mjs commented Jan 4, 2018

  • Include a decent example in README
  • Correct many things that were no longer true due to recent changes
  • Fixed typos and improved wording throughout

Closes #275.

mjs added some commits Jan 4, 2018

Include a decent example in README & correct many errors
There were many things in the README which were no longer true due to
recent changes to the project.
Many small documentation tweaks
Removed the quickstart section as it's not necessary. The README as an
introductory example now, and the current documentation structure is
better now.
Removed copyright headers from examples
This makes the documentation less cluttered (these examples are
included in the docs).

@mjs mjs added the documentation label Jan 4, 2018

@mjs mjs added this to the 2.0.0 milestone Jan 4, 2018

@mjs mjs requested a review from NicolasLM Jan 4, 2018

@mlorant

Looks good, thanks!

import imapclient
with imapclient.IMAPClient(host="imap.foo.org") as c:
c.login("bar@foo.org", "passwd")
c.select_folder("INBOX")
Watching a mailbox using idle
Watching a Mailbox Using IDLE

This comment has been minimized.

@mlorant

mlorant Jan 4, 2018

Contributor

Does the capital M is consistent with other mentions of "mailbox" everywhere else?

@mlorant

mlorant Jan 4, 2018

Contributor

Does the capital M is consistent with other mentions of "mailbox" everywhere else?

This comment has been minimized.

@mjs

mjs Jan 11, 2018

Owner

It's capitalised because this is a heading. Otherwise, I agree that just "mailbox" is correct.

@mjs

mjs Jan 11, 2018

Owner

It's capitalised because this is a heading. Otherwise, I agree that just "mailbox" is correct.

@@ -48,10 +48,6 @@ when maintaining long-lived TCP connections. Users are advised to renew the
IDLE command every 10 minutes to avoid the connection from being abruptly
closed.
Handling large mailboxes

This comment has been minimized.

@mlorant

mlorant Jan 4, 2018

Contributor

Yes, this is not urgent, as long as an issue remains open for later.

@mlorant

mlorant Jan 4, 2018

Contributor

Yes, this is not urgent, as long as an issue remains open for later.

This comment has been minimized.

@mjs

mjs Jan 11, 2018

Owner

That's what I was thinking.

@mjs

mjs Jan 11, 2018

Owner

That's what I was thinking.

@@ -69,7 +69,7 @@ messages in the INBOX folder.
>>> print('ID #%d: "%s" received %s' % (msgid, envelope.subject.decode(), envelope.date))
ID #62: "Our holidays photos" received 2017-07-20 21:47:42
ID #55: "Re: did you book the hotel?" received 2017-06-26 10:38:09
ID #53: "Re: did you book the holel?" received 2017-06-25 22:02:58
ID #53: "Re: did you book the hotel?" received 2017-06-25 22:02:58

This comment has been minimized.

@mlorant

mlorant Jan 4, 2018

Contributor

Good catch 👍

@mlorant

mlorant Jan 4, 2018

Contributor

Good catch 👍

@NicolasLM

This comment has been minimized.

Show comment
Hide comment
@NicolasLM

NicolasLM Jan 4, 2018

Collaborator

I would change the "Project home" to the GitHub repository directly and add the documentation URL as the link GitHub allows to put next to a project description in the top of the page.

Collaborator

NicolasLM commented Jan 4, 2018

I would change the "Project home" to the GitHub repository directly and add the documentation URL as the link GitHub allows to put next to a project description in the top of the page.

Show outdated Hide outdated README.rst
@mjs

This comment has been minimized.

Show comment
Hide comment
@mjs

mjs Jan 11, 2018

Owner

@NicolasLM, good suggestions about linking directly to Github and the documentation. Done.

Owner

mjs commented Jan 11, 2018

@NicolasLM, good suggestions about linking directly to Github and the documentation. Done.

mjs added some commits Jan 11, 2018

Make github.com/mjs/imapclient the official homepage
There's no need for imapclient.freshfoo.com any more.

@mjs mjs merged commit f2f27e5 into master Jan 11, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@mjs mjs deleted the doc-tweaks branch Jan 11, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment