linebender/druid

Sameness for fresh clones

Open

#944 opened on May 15, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (9,091 stars) (567 forks)batch import
D-Easydocshelp wanted

Description

Would it make sense to add to the doc of Data::same that the following property is recommended (or even required)?

assert!(x.same(&x.clone()))

I'm asking because there were some confusion about how to implement Data::same for im::Vector in https://github.com/bodil/im-rs/issues/117 and https://github.com/bodil/im-rs/issues/129. The current doc of Data::same would even allow the following implementation.

impl Data for Foo {
    fn same(&self, _other: &Self) -> bool {
        false
    }
}

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Rust knowledgeFamiliarity with druid's Data trait
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue proposes adding a property to the documentation of `Data::same` that it should satisfy `same(x, x.clone())`. Currently, the documentation is ambiguous and allows returning false. The fix involves modifying the doc comment in the source file where `Data` trait is defined. Check the current doc in the repository and update it to recommend the property. Also ensure consistency with related issues #117 and #129.