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.

Sign up for GitHub

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

Jump to bottom

Fix api doc params #629

Merged
merged 2 commits into from Sep 15, 2020
Merged

Fix api doc params #629

merged 2 commits into from Sep 15, 2020

Conversation

chrisinmtown
Copy link
Contributor

Repairs #626

@chrisinmtown
Copy link
Contributor Author

Oh I see the history is messy, it has a merge commit that I didn't want to push. I hope you can squash on merge.

@Rafiot
Copy link
Member

Rafiot commented Sep 15, 2020

All good, thank you very much for the PR, I'm cleaning it up!

@chrisinmtown
chg: add docstrings and extend conf.py for RTD
f1de0fb 
Add minimal docstrings to public methods so ReadTheDocs will display them.
Add autodoc mock import for lief so RTD can generate HTML for tools.

This fixes issue #626
@lgtm-com
Copy link

lgtm-com bot commented Sep 15, 2020

This pull request introduces 1 alert and fixes 12 when merging ba783f6 into d3db7fe - view on LGTM.com

new alerts:

  • 1 for Syntax error

fixed alerts:

  • 10 for Modification of dictionary returned by locals()
  • 1 for Wrong name for an argument in a call
  • 1 for Variable defined multiple times

@chrisinmtown
Copy link
Contributor Author

Failed CI bcos I sent the wrong version. Hang on.

@chrisinmtown
Copy link
Contributor Author

I don't want you to waste your time cleaning messes I create, I can clean them myself, just comment on what I miss, thanks.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 37.033% when pulling f1de0fb on chrisinmtown:fix-api-doc-params into d3db7fe on MISP:main.

@codecov
Copy link

codecov bot commented Sep 15, 2020 •
edited

Codecov Report

Merging #629 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #629   +/-   ##
=======================================
  Coverage   37.06%   37.06%           
=======================================
  Files          39       39           
  Lines        7724     7724           
=======================================
  Hits         2863     2863           
  Misses       4861     4861
Impacted Files Coverage Δ
pymisp/api.py 12.43% <ø> (ø)
pymisp/mispevent.py 69.46% <ø> (ø)

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 d3db7fe...f1de0fb. Read the comment docs.

@Rafiot
Copy link
Member

Rafiot commented Sep 15, 2020

Excellent, thank you for the fix, you did great work there!

@Rafiot Rafiot merged commit cf3d7e5 into MISP:main Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@chrisinmtown @Rafiot @coveralls