Skip to content

Doc and tests overhaul #43

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

Merged
merged 2 commits into from
Feb 22, 2023
Merged

Doc and tests overhaul #43

merged 2 commits into from
Feb 22, 2023

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Feb 21, 2023

This PR does not change anything about the package functionality, but it improves overall code quality by:

  • Adding quality checks with Aqua.jl to the test suite (fixed an undefined export as a result)
  • Adding a formatting check with JuliaFormatter.jl to the test suite (based on the BlueStyle) $\implies$ changes in the source files are only format-related
  • Moving the actual package tests from doctests to .jl files so that we can distinguish between them (doctests only give one success/fail output and do not give any more internal insight)
  • Re-integrating the package tests into the documentation with Literate.jl
  • Adding a little more detail to the tutorials
  • Adding docstrings to the API reference for functions that are extended from Base and Graphs.jl

@codecov
Copy link

codecov bot commented Feb 21, 2023

Codecov Report

Merging #43 (72c57dc) into master (5044a95) will decrease coverage by 2.97%.
The diff coverage is 94.33%.

@@            Coverage Diff             @@
##           master      #43      +/-   ##
==========================================
- Coverage   94.28%   91.32%   -2.97%     
==========================================
  Files           7        8       +1     
  Lines         245      242       -3     
==========================================
- Hits          231      221      -10     
- Misses         14       21       +7     
Impacted Files Coverage Δ
src/MetaGraphsNext.jl 100.00% <ø> (ø)
src/graphs.jl 82.82% <88.00%> (-6.07%) ⬇️
src/dict_utils.jl 94.28% <100.00%> (-2.86%) ⬇️
src/metadigraph.jl 100.00% <100.00%> (ø)
src/metagraph.jl 84.61% <100.00%> (-2.89%) ⬇️
src/metaundigraph.jl 100.00% <100.00%> (ø)
src/persistence.jl 100.00% <100.00%> (ø)
src/weights.jl 100.00% <100.00%> (ø)
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@gdalle gdalle added the documentation Improvements or additions to documentation label Feb 21, 2023
@gdalle gdalle requested a review from bramtayl February 21, 2023 15:36
@bramtayl
Copy link
Collaborator

Sure, this looks great!

@gdalle gdalle removed the request for review from bramtayl February 22, 2023 08:02
@gdalle gdalle merged commit 6898797 into master Feb 22, 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.

2 participants