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

Cleaning up documentation and tests #153

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

cedricchevalier19
Copy link
Member

Fix #89

@cedricchevalier19 cedricchevalier19 added the documentation Improvements or additions to documentation label May 11, 2022
@codecov
Copy link

codecov bot commented May 11, 2022

Codecov Report

Base: 51.63% // Head: 52.10% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (75a1844) compared to base (1e9ecb6).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #153      +/-   ##
==========================================
+ Coverage   51.63%   52.10%   +0.47%     
==========================================
  Files          36       36              
  Lines        6930     6988      +58     
==========================================
+ Hits         3578     3641      +63     
+ Misses       3352     3347       -5     
Impacted Files Coverage Δ
src/algorithms/hilbert_curve.rs 56.98% <100.00%> (ø)
src/lib.rs 100.00% <100.00%> (ø)
src/algorithms/recursive_bisection.rs 91.75% <0.00%> (+0.17%) ⬆️
src/algorithms/vn/first.rs 93.85% <0.00%> (+3.50%) ⬆️

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

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@hhirtz
Copy link
Member

hhirtz commented May 11, 2022

Thanks! I also rediscovered this link when publishing on crates.io

https://rust-lang.github.io/api-guidelines/print.html

@hhirtz
Copy link
Member

hhirtz commented Jun 7, 2022

I extracted the BoundingBox rename commit[0] in #164

[0] 384c08a

@cedricchevalier19 cedricchevalier19 force-pushed the test-and-clean branch 2 times, most recently from 69ceeae to b043aa2 Compare June 22, 2022 11:31
@hhirtz
Copy link
Member

hhirtz commented Jun 27, 2022

fyi we would want to keep Cargo.lock for libcoupe.so: https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

If you’re building [...] a system library with crate-type of staticlib or cdylib, check Cargo.lock into git.

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.

Proofread doc comments
2 participants