andriyDev / landmass

A navigation system for video games written in Rust.
Apache License 2.0
14 stars 1 forks source link

Add docs for pretty much everything in `bevy_landmass`. #47

Closed andriyDev closed 2 weeks ago

andriyDev commented 2 weeks ago

Some of the docs could maybe use some work but at least we've got some now!

codecov-commenter commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 97.6%. Comparing base (29ee7e9) to head (71b9a9e).

Additional details and impacted files | [Files](https://app.codecov.io/gh/andriyDev/landmass/pull/47?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [crates/bevy\_landmass/src/landmass\_structs.rs](https://app.codecov.io/gh/andriyDev/landmass/pull/47?src=pr&el=tree&filepath=crates%2Fbevy_landmass%2Fsrc%2Flandmass_structs.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-Y3JhdGVzL2JldnlfbGFuZG1hc3Mvc3JjL2xhbmRtYXNzX3N0cnVjdHMucnM=) | `27.7% <ø> (ø)` | | | [crates/bevy\_landmass/src/nav\_mesh.rs](https://app.codecov.io/gh/andriyDev/landmass/pull/47?src=pr&el=tree&filepath=crates%2Fbevy_landmass%2Fsrc%2Fnav_mesh.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-Y3JhdGVzL2JldnlfbGFuZG1hc3Mvc3JjL25hdl9tZXNoLnJz) | `92.3% <ø> (ø)` | | | [crates/bevy\_landmass/src/util.rs](https://app.codecov.io/gh/andriyDev/landmass/pull/47?src=pr&el=tree&filepath=crates%2Fbevy_landmass%2Fsrc%2Futil.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-Y3JhdGVzL2JldnlfbGFuZG1hc3Mvc3JjL3V0aWwucnM=) | `100.0% <ø> (ø)` | | | [crates/bevy\_landmass/src/lib.rs](https://app.codecov.io/gh/andriyDev/landmass/pull/47?src=pr&el=tree&filepath=crates%2Fbevy_landmass%2Fsrc%2Flib.rs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-Y3JhdGVzL2JldnlfbGFuZG1hc3Mvc3JjL2xpYi5ycw==) | `89.2% <0.0%> (ø)` | |