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

docs: Update CHANGELOG.md to link to updated switch example #1582

Merged
merged 14 commits into from
Jan 20, 2023
Merged

docs: Update CHANGELOG.md to link to updated switch example #1582

merged 14 commits into from
Jan 20, 2023

Conversation

richb-hanover
Copy link
Contributor

I was surprised to see the => syntax described as 0.5.0, yet have it implemented in the current Playground.

I would suggest that we use the "0.x.y - Unreleased" section to contain everything that is currently implemented, even if it arrives prior to its "stated delivery date/release" in the Roadmap.

richb-hanover and others added 2 commits January 19, 2023 07:23
I was surprised to see the `=>` syntax described as 0.5.0, yet have it implemented in the current Playground.

I would suggest that we use the "0.x.y - Unreleased" section to contain _everything_ that is currently implemented, even if it arrives prior to its "stated delivery date/release" in the Roadmap.
@snth
Copy link
Member

snth commented Jan 19, 2023

I agree with you and just commented on this in #1581.

While I'm very much for the change, we need to figure something out about the release process and website updates.

@richb-hanover richb-hanover changed the title Update CHANGELOG.md to link to updated switch example docs: Update CHANGELOG.md to link to updated switch example Jan 19, 2023
@max-sixty
Copy link
Member

I think we can add a section to the template with **Breaking changes**, WDYT?

@TaxFairness
Copy link

I think we can add a section to the template with **Breaking changes**, WDYT?

I have seen the separate "Breaking Changes" section, but I have a sense that we should keep all the "features" (new or altered) together. They're what most people want/need to see.

As I look at the 0.3.0 CHANGELOG entries, I would have placed all seven (three breaking, four new) items in the same group so they're seen as the "Big News" part of the release. All the rest of the 0.3.0 entries are careful reporting of other stuff that happened. By marking each of those three as Breaking change, that information stays with the feature description (and won't get lost if items get re-ordered).

@richb-hanover
Copy link
Contributor Author

Uh oh... @TaxFairness (my alter-ego) responded. It was really me :-)

@max-sixty
Copy link
Member

Uh oh... @TaxFairness (my alter-ego) responded. It was really me :-)

I agree with your alter ego!

@aljazerzen
Copy link
Member

This change was placed in 0.5.0 section because it is a breaking change, which cannot go into a patch release.

The fact that playground & book immediately contained the change is a separate problem from #1507

@aljazerzen
Copy link
Member

Disregard that: semver states that "Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable."

@TaxFairness
Copy link

I'm glad to hear a citation for the rule (which makes complete sense). Thanks.

@aljazerzen
Copy link
Member

Since the breaking change has been reverted, I removed the entry in the changelog, but kept the extended entry about from_text.

Thanks for contributing.

@aljazerzen aljazerzen enabled auto-merge (squash) January 20, 2023 13:03
@aljazerzen aljazerzen merged commit f8534c8 into PRQL:main Jan 20, 2023
@max-sixty
Copy link
Member

Good changes, thank you!

@richb-hanover richb-hanover deleted the patch-3 branch January 20, 2023 22:11
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

Successfully merging this pull request may close these issues.

5 participants