Rename `get_sundered_data()`?

[etiennebacher]

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!

[paddymul]

I'm a native speaker, and sundered isn't quite obvious to me either on an initial look. On https://posit-dev.github.io/pointblank/user-guide/sundering.html

maybe just include the dictionary definition of sunder rendered in a dictionary like way. https://www.merriam-webster.com/dictionary/sunder. Something like:

sunder
transitive verb

• to break apart or in two : separate by or as if by violence or by intervening time or space