mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 12:43:34 +00:00
f9c1a8a3d5
# Objective This PR aims to document the `bevy_asset` crate to complete coverage, while also trying to improve some bits of UX. ### Progress - [x] Root items - [x] `handle` module - [x] `info` module - [x] `path` module - [x] `loader` module - [x] `io` and `filesystem_watcher` module - [x] `assets` module - [x] `asset_server` module - [x] `diagnostic` module - [x] `debug_asset_server` module - [x] Crate level documentation - [x] Add `#![warn(missing_docs)]` lint Coverage: 100% ## Migration Guide - Rename `FileAssetIo::get_root_path` uses to `FileAssetIo::get_base_path` `FileAssetIo::root_path()` is a getter for the `root_path` field, while `FileAssetIo::get_root_path` returned the parent directory of the asset root path, which was the executable's directory unless `CARGO_MANIFEST_DIR` was set. This change solves the ambiguity between the two methods. |
||
---|---|---|
.. | ||
src | ||
Cargo.toml |