Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent naming #117

Open
Thomas-Lemoine opened this issue Aug 7, 2023 · 0 comments
Open

Consistent naming #117

Thomas-Lemoine opened this issue Aug 7, 2023 · 0 comments

Comments

@Thomas-Lemoine
Copy link
Collaborator

The difference between an item, an entry and an article is often unclear or mixed, and it could be clarified within the method and variable names as well as some type signatures. Also, fetch_entries and make_data_entry and unprocessed_items and process_entry would benefit from clearer naming schemes (for example, process_entry could return the data_dict instead of self.make_data_entry(data_dict), which makes an article so should be renamed to make_article, etc.) Not really critical, mostly just helps avoid bugs down the line. There's also two AlignmentDataset classes, one of which would make more sense to be named a SourceHandler which all different source handlers inherit from, potentially? Not sure though

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant