Scalar comparisons only work when the units are identical. This is not covered in documentation.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Tech Debt
I was expecting that 0.5 V would be the same as 500 mV, but that is not how this software works. I would like to see the documentation updated to reflect this comparison constraint.
Given that the comparison functions will be invoked through operators, the class documentation seems like a good place to capture this information.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the class documentation for the type whose scalar comparison functions are invoked through operators. Confirm how the existing comparison behavior is described, then document that scalar comparisons require identical units rather than treating equivalent values such as 0.5 V and 500 mV as equal. Done means the comparison constraint is clearly stated in the class documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100