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

Rename example "dataset" classes, for clarity and collision avoidance #130

Open
apjanke opened this issue Feb 10, 2024 · 0 comments
Open
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@apjanke
Copy link
Owner

apjanke commented Feb 10, 2024

Tablicious has a few different classes with base namedataset or datasets, enough to be confusing.

They're all example-dataset stuff, and are not equivalents of Matlab's dataset or the dataset in OF Statistics. Plus, similar class names that differ only in their namespace qualification or the "s" at the end can be confusing. And a name collision on just the base name of a namespaced class with a standard class could be a problem, e.g. when cd'ing around, in doctest, or in Octave stuff that doesn't properly support namespaces.

Rename them to something better. Do it for a minor version release, bc even though these are only in the examples code, that would be a bit of a breaking change for users.

Here, "ex dataset" is short for "example dataset".

Current classes:

  • tblish.datasets - public interface to our ex datasets
  • tblish.dataset - convenience wrapper around tblish.datasets, presenting them as static methods for tab-completion etc
  • tblish.internal.dataset - internal implementation stuff for tblish.datasets (not tblish.dataset directly)
  • +tblish.internal.datasets - namespace holding each ex dataset as an individual class
  • tblish.internal.datasets.<name> - the actual ex dataseets, one per class, in @<name> directories to support resource files

What to do

I'm thinking it should be like "exdatasets" instead, and the +internal ones with "impl" or something in their base name. Maybe capitalize the class names, too? Though tblish.dataset is kinda mimicking a package in terms of the interface it presents. I dunno.

References

@apjanke apjanke added this to the 0.5.0 milestone Feb 10, 2024
@apjanke apjanke self-assigned this Feb 10, 2024
@github-project-automation github-project-automation bot moved this to Needs triage in Octave-Tablicious Feb 10, 2024
@apjanke apjanke added the enhancement New feature or request label Feb 10, 2024
@apjanke apjanke moved this from Needs triage to Low priority in Octave-Tablicious Feb 10, 2024
@apjanke apjanke changed the title Rename example dataset classes, for clarity and collision avoidance Rename example "dataset" classes, for clarity and collision avoidance Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Low priority
Development

No branches or pull requests

1 participant