Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Object equality: doctest-able examples covering special cases #299

Open
sadielbartholomew opened this issue Jan 21, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@sadielbartholomew
Copy link
Member

sadielbartholomew commented Jan 21, 2022

There is a lack of concrete examples in the API reference across the equals methods available on the various construct and data objects (see e.g. the end of the references here and here) so during #254 we agreed it would be good to add in a good range of examples, ideally eventually doctest-able (i.e. inclusive of set-up of the objects referred to), which in the process of verifying and documenting should enable us to ensure behaviour is known and consistent in relation to such aspects as:

  • management of self-equality (a.equals(a)) and whether to short-circuit on copies (a.equals(a.copy()));
  • handling of subtleties of data (including relevant keywords to toggle these), e.g: how to deal with masked arrays, NaN values, different data types with equivalent data, compression etc.;
  • handling of potential subtleties of metadata (not explored so much as with the above in Data.equals: add unit test & migrate to Dask #254, but I don't doubt there are some).
@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant