Skip to content

Commit

Permalink
Remove outdated doc (#270)
Browse files Browse the repository at this point in the history
* Remove outdated doc

* Update changelog
  • Loading branch information
aleokdev authored May 24, 2023
1 parent 7182516 commit 4f94470
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## Changed
- Updated `Image` docs. (#270)

## [0.11.1]
### Added
- WASM support + `wasm` feature; Check `README.md` for instructions on how to set it up. (#252)
Expand Down
8 changes: 1 addition & 7 deletions src/image.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,7 @@ pub struct Image {
/// The crate does not currently support embedded images (Even though Tiled
/// does not allow creating maps with embedded image data, the TMX format does; [source])
///
/// Currently, the crate is not prepared to handle anything but OS paths. Using VFS is a hard
/// task that involves a lot of messy path manipulation. [Tracking issue]
///
/// [source]: https://doc.mapeditor.org/en/stable/reference/tmx-map-format/#image
/// [Tracking issue]: https://github.com/mapeditor/rs-tiled/issues/37
///
/// ## Example
/// ```
Expand Down Expand Up @@ -53,9 +49,7 @@ pub struct Image {
/// Path::new("assets/folder/../tilesheet.png")
/// );
///
/// // If you are using the OS's filesystem, figuring out the real path of the image is as easy
/// // as canonicalizing the path. If you are using some sort of VFS, this task is much harder
/// // since std::path is meant to be used with the OS. This will be fixed in the future!
/// // Figuring out the real path of the image is as easy as canonicalizing it.
/// let image_source = image_source.canonicalize()?;
/// assert!(File::open(image_source).is_ok());
/// # Ok(())
Expand Down

0 comments on commit 4f94470

Please sign in to comment.