Skip to content

Conversation

eurunuela
Copy link
Collaborator

Closes #42 .

This PR adds the documentation related to the package.

@eurunuela eurunuela added the documentation Improvements or additions to documentation label Jan 17, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #46 (1e8a8db) into main (0ae41bb) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #46   +/-   ##
=======================================
  Coverage   90.42%   90.42%           
=======================================
  Files           3        3           
  Lines         282      282           
=======================================
  Hits          255      255           
  Misses         27       27           

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 0ae41bb...1e8a8db. Read the comment docs.

@handwerkerd
Copy link
Member

Great start! My one general comment is that, as a learning tool, it would be nice to have a few more "why" comments instead of the current "what" comments. That is, you include things like "Step 2: Apply kurtosis threshold of Gaussianity to SVD data to get first estimate of subsampling depth" without saying why this step is happening. This doesn't have to be a textbook level of detail, but a sentence or two at the beginning of each code block explain why each step is done would help.

@eurunuela eurunuela mentioned this pull request Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation missing

3 participants