`diff` doc is unclear
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5.2k
- Forks
- 280
- Avg merge
- 6d 17h
- Merged PRs (30d)
- 4
Description
The current doc for diff() could be made clearer, e.g.:
Diff iterates over each sequence, one item at a time for each sequence, and yields tuples when these items aren't all equal.
Encountering the function's name for the first time, I was expecting it would do something like the sql equivalent of select from seq1 except select from seq2 except select from seq3 ...) with seq2, ..., seqn (or some kind of hash to represent their values) needing to fit in memory.
A real world example of the function in use might also be helpful.
Contributor guide
No contributing guide indexed for this repository
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 by locating the current documentation for toolz's diff() function and read its existing description. Clarify that diff() iterates over sequences in parallel and yields tuples when values differ, then add a real-world usage example; the updated documentation should remove the ambiguity about SQL-style set difference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100