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

Does ECCOMetadata have dates or a date? (Should we use a different design for ECCOMetadata?) #224

Open
glwagner opened this issue Nov 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@glwagner
Copy link
Member

glwagner commented Nov 8, 2024

The docstring says date

- `date`: The date of the metadata (default: DateTimeProlepticGregorian(1993, 1, 1)).

but the actual function signature requires dates:

dates = DateTimeProlepticGregorian(1993, 1, 1),

I also want to note that I think this design is confusing. The user interface is confusing, and it also makes the source code confusing.

Another design could be to have ECCOMetadata represent a single instance and then use a vector of ECCOMetadata to represent many of them (if that is even necessary).

Anything to make the design more explicit with less hidden suprises.

@glwagner glwagner added the documentation Improvements or additions to documentation label Nov 8, 2024
@glwagner
Copy link
Member Author

glwagner commented Nov 8, 2024

I guess another possibility is to discontinue "single date" support, so users just have to write [date] if they want one date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant