AstraZeneca / chemicalx

A PyTorch and TorchDrug based deep learning library for drug pair scoring. (KDD 2022)
https://chemicalx.readthedocs.io
Apache License 2.0
700 stars 89 forks source link

Standardize documentation style with `darglint` #70

Closed cthoyt closed 2 years ago

cthoyt commented 2 years ago

Summary

This PR adds the darglint plugin for flake8, whose job it is to check that documentation is provided in the correct format.

Changes

codecov-commenter commented 2 years ago

Codecov Report

Merging #70 (82ada2b) into main (a6f2b73) will increase coverage by 0.02%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #70      +/-   ##
==========================================
+ Coverage   93.74%   93.76%   +0.02%     
==========================================
  Files          29       29              
  Lines         815      818       +3     
==========================================
+ Hits          764      767       +3     
  Misses         51       51              
Impacted Files Coverage Δ
chemicalx/data/batchgenerator.py 98.30% <ø> (ø)
chemicalx/data/contextfeatureset.py 100.00% <ø> (ø)
chemicalx/data/drugfeatureset.py 100.00% <ø> (ø)
chemicalx/data/labeledtriples.py 100.00% <ø> (ø)
chemicalx/models/deepsynergy.py 100.00% <ø> (ø)
chemicalx/models/epgcnds.py 100.00% <ø> (ø)
chemicalx/models/matchmaker.py 95.00% <ø> (ø)
chemicalx/data/datasetloader.py 87.23% <100.00%> (+0.27%) :arrow_up:

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 a6f2b73...82ada2b. Read the comment docs.