search

juce-framework / JUCE

JUCE is an open-source cross-platform C++ application framework for desktop and mobile applications, including VST, VST3, AU, AUv3, LV2 and AAX audio plug-ins.
https://juce.com
Other
6.31k stars 1.67k forks source link

Recent DynamicObject::writeAsJSON() breaking change issue not documented #1313

Closed danra closed 6 months ago

danra commented 7 months ago

Detailed steps on how to reproduce the bug

Commit 224c4f706ba0988441e7269c3e7f2b9d5d242cbb changed DynamicObject::writeAsJSON()'s signature. BREAKING_CHANGES.txt mentions possible issues with overriding classes, but there's also just the issue of having to modify any existing callers that's not mentioned.

Would be nice to either: 1) mention that issue as well and show a migration example; or, even better: 2) keep the previous overload in place, make it non-virtual, and make it call the new virtual overload. That would actually make the BREAKING_CHANGES.txt complete as is because just consumers won't have to change anything.

What is the expected behaviour?

-

Operating systems

Other

What versions of the operating systems?

-

Architectures

Other

Stacktrace

No response

Plug-in formats (if applicable)

No response

Plug-in host applications (DAWs) (if applicable)

No response

Testing on the develop branch

The bug is present on the develop branch

Code of Conduct

danra commented 6 months ago

I see this was resolved on develop, thanks!