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

Use autofocus for all module documentation/docstrings #737

Merged
merged 3 commits into from
Feb 15, 2018
Merged

Conversation

alexwlchan
Copy link
Contributor

Picking up Hynek’s comment from #734:

Nobody wanted to spend their time to move everything to docstrings yet.

I had half an hour to spare at the station. Voila.

Not only is this neater for devs working on the code, it fixes a bunch of inaccuracies – methods whose signature had changed, added/removed methods, and makes a few docstrings consistent with the published docs.

@codecov
Copy link

codecov bot commented Feb 13, 2018

Codecov Report

Merging #737 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #737   +/-   ##
=======================================
  Coverage   97.05%   97.05%           
=======================================
  Files          18       18           
  Lines        5711     5711           
  Branches      395      395           
=======================================
  Hits         5543     5543           
  Misses        112      112           
  Partials       56       56
Impacted Files Coverage Δ
src/OpenSSL/crypto.py 96.86% <ø> (ø) ⬆️
src/OpenSSL/SSL.py 94.95% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d231f0...68acb78. Read the comment docs.

@jlaine
Copy link
Contributor

jlaine commented Feb 13, 2018

Wow, that's very cool! Does it solve #730 in the process by any chance?

@alexwlchan
Copy link
Contributor Author

@jlaine There were a bunch of places where the docstring didn't match the docs (or places where the docs explained a method that didn't exist!) – whether #730 is fixed will depend on whether those docstrings are correct, and I haven't checked.

@hynek hynek merged commit d072cae into master Feb 15, 2018
@hynek hynek deleted the docstrings branch February 15, 2018 09:58
@hynek
Copy link
Contributor

hynek commented Feb 15, 2018

Thanks, this was very much overdue!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants