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

Improve docs and style #38

Merged
merged 2 commits into from
Apr 5, 2023
Merged

Improve docs and style #38

merged 2 commits into from
Apr 5, 2023

Conversation

gdalle
Copy link
Member

@gdalle gdalle commented Mar 30, 2023

  • Add docstrings everywhere
  • Clean up code style to activate CI style check
  • Rework the README into a tutorial page
  • Stress performance aspects

@gdalle
Copy link
Member Author

gdalle commented Mar 30, 2023

This fixes #35 and #18

@codecov
Copy link

codecov bot commented Mar 30, 2023

Codecov Report

Merging #38 (d956a63) into master (25b9d91) will decrease coverage by 1.00%.
The diff coverage is 91.73%.

@@            Coverage Diff             @@
##           master      #38      +/-   ##
==========================================
- Coverage   95.82%   94.83%   -1.00%     
==========================================
  Files           6        9       +3     
  Lines         407      445      +38     
==========================================
+ Hits          390      422      +32     
- Misses         17       23       +6     
Impacted Files Coverage Δ
src/SimpleWeightedGraphs.jl 100.00% <ø> (+10.52%) ⬆️
src/conversion.jl 75.00% <75.00%> (ø)
src/simpleweightededge.jl 82.75% <79.16%> (-1.46%) ⬇️
src/abstractsimpleweightedgraph.jl 88.88% <88.88%> (ø)
src/persistence.jl 97.56% <90.00%> (-2.44%) ⬇️
src/simpleweightedgraph.jl 93.39% <91.66%> (-0.49%) ⬇️
src/simpleweighteddigraph.jl 96.47% <98.07%> (+0.52%) ⬆️
src/overrides.jl 100.00% <100.00%> (+0.99%) ⬆️
src/utils.jl 100.00% <100.00%> (ø)

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

@matbesancon
Copy link
Member

LGTM!

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.

2 participants