Skip to content

Rename get_sundered_data()? #201

@etiennebacher

Description

@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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions