coveralls
commented
5 years ago Pull Request Test Coverage Report for Build 42
- 3 of 17 (17.65%) changed or added relevant lines in 5 files are covered.
- 6 unchanged lines in 4 files lost coverage.
- Overall coverage remained the same at 56.147%
| Changes Missing Coverage | Covered Lines | Changed/Added Lines | % | ||
|---|---|---|---|---|---|
| src/Henry.jl | 0 | 1 | 0.0% | ||
| src/Crystal.jl | 1 | 5 | 20.0% | ||
| src/Molecules.jl | 0 | 4 | 0.0% | ||
| src/GCMC.jl | 0 | 5 | 0.0% | ||
| <!-- | Total: | 3 | 17 | 17.65% | --> |
| Files with Coverage Reduction | New Missed Lines | % | ||
|---|---|---|---|---|
| src/GCMC.jl | 1 | 0.0% | ||
| src/Crystal.jl | 1 | 80.3% | ||
| src/Energetics_Util.jl | 2 | 72.22% | ||
| src/ElectrostaticEnergetics.jl | 2 | 95.16% | ||
| <!-- | Total: | 6 | --> |
| Totals | |
|---|---|
| Change from base Build 41: | 0.0% |
| Covered Lines: | 717 |
| Relevant Lines: | 1277 |
Created all files to create a documentation page on github pages. It uses Documenter.jl to pull the docstrings from functions and show them in the documentation page. I filled in any functions that are exported but didn't have a docstring to the best of my ability, but everyone should look it over and make sure these are accurate descriptions of the functions.
Here is a list of docstrings I wrote sorted by the files they came from: -EnergeticsUtil.jl --PotentialEnergy --SystemPotentialEnergy
-GCMC.jl --gcmc_result_save_name
-Henry.jl --henry_result_savename
-MCHelpers.jl --rotatable
-Molecules.jl --charged
-NearestImage.jl --shortest_r --shortest_r^2
The way the functions are formatted and organized can be changed easily by placing them in a different md file in the src (putting them in their own page on the site), listing the new md file in the make.jl file, and running the make.jl file.
The site can be tested locally by using mkdocs. It is prepared by using
mkdocs buildthis will prepare it for the first time or update it based on changes you've made. To start serving the site, runmkdocs serveand it will give you a site to go to on a browser.