search

Chemellia / ChemistryFeaturization.jl

Interface package for featurizing atomic structures
https://chemistryfeaturization.chemellia.org/dev/
MIT License
41 stars 14 forks source link

Add more docs #96

Closed thazhemadam closed 3 years ago

thazhemadam commented 3 years ago

At this point, I'm just writing down stuff I've made notes of (both mental, and tangible), so I'm not really particular about having things organized the way they are currently (or even having all this content finally make it into the docs for that matter).

codecov-commenter commented 3 years ago

Codecov Report

Merging #96 (24c3830) into main (7c3ba5b) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #96   +/-   ##
=======================================
  Coverage   80.81%   80.81%           
=======================================
  Files          12       12           
  Lines         318      318           
=======================================
  Hits          257      257           
  Misses         61       61
Impacted Files Coverage Δ
src/features/features.jl 66.66% <ø> (ø)
src/featurizations/featurizations.jl 100.00% <ø> (ø)

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 7c3ba5b...24c3830. Read the comment docs.

rkurchin commented 3 years ago

@thazhemadam there are probably still things we could add in docs but I'm fine with merging this nowish, especially since there have been a couple people expressing interest in the package after JuliaCon, so having the tutorial up would be good.

Thoughts?

rkurchin commented 3 years ago

I think this resolves #3

thazhemadam commented 3 years ago

I agree. I think atm there's enough content in the docs to get things up and running. We can always open up a new PR anyways when we want to add more content. Merging this PR.