4f2fa81cef
# Objective
- The `#[deprecated]` attributes supports a `since` field, which
documents in which version an item was deprecated. This field is visible
in `rustdoc`.
- We inconsistently use `since` throughout the project.
For an example of what `since` renders as, take a look at
`ChildOf::get()`:
```rust
/// The parent entity of this child entity.
#[deprecated(since = "0.16.0", note = "Use child_of.parent() instead")]
#[inline]
pub fn get(&self) -> Entity {
self.0
}
```
## Solution
- Add `since = "0.16.0"` to all `#[deprecated]` attributes that do not
already use it.
- Add an example of deprecating a struct with the `since` field in the
migration guide document.
I would appreciate if this could be included in 0.16's release, as its a
low-risk documentation improvement that is valuable for the release, but
I'd understand if this was cut.
## Testing
You can use `cargo doc` to inspect the rendered form of
`#[deprecated(since = "0.16.0", ...)]`.
|
||
|---|---|---|
| .. | ||
| clone_entities.rs | ||
| entity_set.rs | ||
| hash_map.rs | ||
| hash_set.rs | ||
| hash.rs | ||
| index_map.rs | ||
| index_set.rs | ||
| map_entities.rs | ||
| mod.rs | ||
| unique_array.rs | ||
| unique_slice.rs | ||
| unique_vec.rs | ||