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

📚 SequenceSet API is considered stable now #318

Merged
merged 4 commits into from
Sep 13, 2024
Merged

Conversation

nevans
Copy link
Collaborator

@nevans nevans commented Sep 13, 2024

SequenceSet's API should now be considered "stable". This PR updates the SequenceSet documentation, to remove the "experimental" notice at the top.

This PR depends on #319, which makes a minor breaking change to the API.

This can simplify some calling code.
Each member of the set should be an integer, a range, or a sequence-set
formatted string.  SequenceSet should not allow Set inputs to be nested.
Other enumerable types are no longer valid inputs.
@nevans nevans added this to the v0.5 milestone Sep 13, 2024
@nevans nevans changed the title 💥 SequenceSet input validation for Set, Array, and enumerables 📚 SequenceSet API is considered stable now Sep 13, 2024
@nevans
Copy link
Collaborator Author

nevans commented Sep 13, 2024

I split this into two PRs for documentation (i.e: to simplify generating release notes.) 🙂

@nevans nevans merged commit 004305e into master Sep 13, 2024
18 checks passed
@nevans nevans deleted the sequence-set-stable-api branch September 13, 2024 15:06
@nevans nevans added the documentation Improvements or additions to documentation label Nov 12, 2024
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
Development

Successfully merging this pull request may close these issues.

1 participant