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

Make a spec/compatibility page #288

Open
pbiggar opened this issue Oct 11, 2022 · 0 comments
Open

Make a spec/compatibility page #288

pbiggar opened this issue Oct 11, 2022 · 0 comments
Assignees

Comments

@pbiggar
Copy link
Member

pbiggar commented Oct 11, 2022

Since each library is supposed to be pretty similar, they should have the same functions and mostly work the same.

Some ideas for how to help this:

A spec

Something like a yaml file with a list of functions, their arguments, and the doc strings for each one.

Shared test suite

If we had a single place (the spec yaml file?) with a set of expected input/output for each function, then we could possibly generate the tests for each language from them. This would keep them compatible and make it easier to add new libraries.

Compatibility page

List of functions and whether it's support in each variant. Could also include manual annotations when functions work differently in different versions.

Perhaps could be derived manually from the spec and test suite

@pbiggar pbiggar added this to the 0.2.0 milestone Oct 11, 2022
@pbiggar pbiggar self-assigned this Oct 13, 2022
@pbiggar pbiggar mentioned this issue Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant