#2989·Carbon

More granular v2 to v3 upgrade documentation?

Author: stevenmaguireCreated Apr 1, 2024Updated Apr 11, 2024
Labelsdocumentation

I have read the upgrade guide on the documentation site: https://carbon.nesbot.com/docs/#api-carbon-3

I've worked through the upgrade guide and I am still catching errant issues related to changes in parameter types of methods here and there. For instance createFromFormat (which invokes rawCreateFromFormat with similar signature) was previously untyped and now explicitly expects, for example, a string for parameter # 2, $time.

Example: A valid use case currently supported by v2 is passing in a year and month (202401), which happens to be an int, in conjunction with a `Ym' format.

This issue is not intended to open a discussion about the choices for what types are expected, but rather a consideration for additional documentation to explicitly clear up the public methods which need attention during a proactive upgrade effort. A punch list of sorts?

The diffIn* section is forthcoming about significant issues related to the return type changes and offers the most detailed guidance.

I am left worried that the inventory of 400+ public methods contains more undocumented breaking changes than currently hinted at in the ~500 word guide at the link above.

Is there bandwidth to update the upgrade guide with a more detailed inventory of which of those 400+ public methods contain, not just return type changes, but also parameter type changes? With acknowledgement that going from no type to a type is a type change.