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

Document mset.Size versus len(mset) in Python (and Julia?) #329

Open
dannys4 opened this issue Apr 17, 2023 · 0 comments
Open

Document mset.Size versus len(mset) in Python (and Julia?) #329

dannys4 opened this issue Apr 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@dannys4
Copy link
Contributor

dannys4 commented Apr 17, 2023

This is something that isn't very well documented and has tripped me up before, and has now tripped up @rubiop on an example. This should probably be documented well because using the wrong one can cause insidious and misleading behavior.

Honestly, we may want to think about renaming, since "size" could easily mean dimension of input or number of elements in the set and "length" honestly seems to me like "number of elements in the set". If we did this, it would (clearly) be breaking so renaming is a change that we save for 3.0. Personally, I would suggest using Cardinality instead of Size to indicate that it's the number of elements in a set, and Dim(ension) instead of Length to show it's about dimension, but those are my two cents.

@dannys4 dannys4 added enhancement New feature or request good first issue Good for newcomers documentation Improvements or additions to documentation labels Apr 17, 2023
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant