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

Expand API docs and add missing test coverage #150

Merged
merged 20 commits into from
Dec 22, 2016
Merged

Conversation

twm
Copy link
Contributor

@twm twm commented Nov 15, 2016

  • Add missing modules to the API docs
  • Fix various bits of broken reST syntax
  • Add _Response.collect() method which was in the API docs, but not actually implemented!

To do:

  • Clean up the index a little (the headers become a little redundant with these changes).
  • Add a test for _Response.collect(), unless reviewers think that it should be removed from the docs instead of added to the implementation.
  • Add a tox rule to build the docs. They're probably so broken because there's no out-of-the-box way to check what they look like.

There is now a warning in the Sphinx build which I haven't managed to get rid of: sphinx-doc/sphinx#2549

@twm twm changed the title Api docs API docs Nov 15, 2016
@codecov-io
Copy link

codecov-io commented Nov 15, 2016

Current coverage is 96.54% (diff: 100%)

Merging #150 into master will increase coverage by 0.22%

@@             master       #150   diff @@
==========================================
  Files            20         20          
  Lines          1713       1738    +25   
  Methods           0          0          
  Messages          0          0          
  Branches        152        154     +2   
==========================================
+ Hits           1650       1678    +28   
+ Misses           42         39     -3   
  Partials         21         21          

Powered by Codecov. Last update b436c6c...00084f3

@twm twm changed the title API docs Expand API docs and add missing test coverage Nov 16, 2016
@glyph
Copy link
Member

glyph commented Dec 19, 2016

I want to just merge this but it has pending conflicts :( can you address those, please, @twm?

@twm
Copy link
Contributor Author

twm commented Dec 21, 2016

@glyph Okay, done.

@glyph
Copy link
Member

glyph commented Dec 22, 2016

Awesome. I was just helping out a Twisted user today and had to lament the fact that treq.testing did not show up in the API docs. Thanks a bunch!

@glyph glyph merged commit fcf5deb into twisted:master Dec 22, 2016
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

Successfully merging this pull request may close these issues.

3 participants