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

Add a few more docstrings #70

Merged
merged 1 commit into from
Mar 8, 2020
Merged

Add a few more docstrings #70

merged 1 commit into from
Mar 8, 2020

Conversation

timholy
Copy link
Contributor

@timholy timholy commented Mar 8, 2020

Other than _avx_!, every export is documented including LoopVectorization itself. (I don't always remember, but I often like to provide a brief API summary of a package in the module's docstring). It also adds a new API reference page to the Documenter docs.

Sorry about the whitespace changes, my Atom settings do it automatically.

@codecov-io
Copy link

codecov-io commented Mar 8, 2020

Codecov Report

Merging #70 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #70   +/-   ##
=======================================
  Coverage   92.91%   92.91%           
=======================================
  Files          26       26           
  Lines        2836     2836           
=======================================
  Hits         2635     2635           
  Misses        201      201
Impacted Files Coverage Δ
src/filter.jl 100% <ø> (ø) ⬆️
src/constructors.jl 97.18% <ø> (ø) ⬆️
src/costs.jl 84.9% <ø> (ø) ⬆️
src/LoopVectorization.jl 100% <ø> (ø) ⬆️
src/map.jl 100% <100%> (ø) ⬆️
src/broadcast.jl 89.34% <100%> (ø) ⬆️

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 a31acc4...eebe3b1. Read the comment docs.

@chriselrod
Copy link
Member

These look great.

@chriselrod chriselrod merged commit 64f765d into JuliaSIMD:master Mar 8, 2020
@timholy timholy deleted the teh/docstrings branch March 8, 2020 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants