Please fix the release notes!
-
Hey,
I think it’s great that whoever has been writing the release notes is adding some… personality to them. Sadly it’s coming at the cost of readability and actionability.
Release notes are a developer’s major (and often only) way to keep up with code changes. When the changes aren’t indicated clearly, or they’re lost in a paragraph of mixed metaphors, it makes it really hard to understand what’s actually changed and whether they need to be worried about breakages in their custom implementations.
While this could technically be solved for the free plugins by linking to the GitHub PR, there’s no counterpart for the premium addons.
Here’s an example from the most recent change log (note: it’s by far not the worst one from the last several releases)
>There are so many ways to display prices. But if you’re displaying a price in a format other than English, it would get a little jumbled when passing through the REST API where decimal and thousands event cost separators show incorrect values. We made a change that makes more cents of the issue so that prices are deposited to the API correctly.
I literally have no idea what changed with this. Was this a simple formatting change that only affects output of separators, or is the price value being stored differently? Does it affect getting values or setting (aka ‘depositing’ them)? And why am I trying to decode a paragraph of text?
The topic ‘Please fix the release notes!’ is closed to new replies.