posit-dev / posit-dev/pointblank
Rename `get_sundered_data()`?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 490
- Forks
- 32
- Avg merge
- 14h 24m
- Merged PRs (30d)
- 2
Description
Hi, I'm using the fact this library is quite recent to give some feedback regarding the API design, specifically the name of get_sundered_data(). This was the first time I read the word "sunder" (I'm not a native speaker) and it was quite obscure to me. According to Google n-gram, this word was mostly used 200 years ago: https://books.google.com/ngrams/graph?content=sunder%2C+sundering%2C+sundered&year_start=1800&year_end=2022&corpus=en&smoothing=3
This function is the first thing I was looking for since I want to do batch validation on many files and I want to extract all failing cases in separate files. However, the name made it a bit hard to find in the docs. To me (and colleagues), reading get_sundered_data() in a script is not very clear, and I'm wondering if you'd be open to renaming it. Since there already exists get_data_extracts(), I think get_data_results(type = "pass"/"fail") (or something similar) would be clearer.
Just my 2 cents, thanks!
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
Locate the implementation and documentation for get_sundered_data() and compare its role with get_data_extracts(). Review the proposed naming alternatives and the public API references; done means the agreed function name and all corresponding documentation and examples are updated consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100