版本控制#

Vega-Altair 历来发布的主要版本与 Vega-Lite 的版本相一致。

随着项目的成熟,主要版本的发布变得不那么频繁,出现了在这些主要版本之间引入重大变更的日益需要。这些变更将使Vega-Altair能够解决技术债务并改善API的人机工程学。

NoneNone

为了确保未来的版本清晰地传达变更,Vega-Altair将致力于采用 SemVer

NoneNone

公共API#

API Reference 中记录的功能定义了 Vega-Altair 公共 API。

版本号#

A Vega-Altair 版本号由 MAJOR.MINOR.PATCH 组成。

NoneNone
  • 向后不兼容的API更改增加了主要版本 (4.2.2 - 5.0.0)

  • NoneNone
  • 新的向后兼容功能增加 次要 版本 (5.2.0 - 5.3.0)

  • 向后兼容的错误修复会增加PATCH版本 (5.1.1 - 5.1.2)

主要 版本可能会继续增加,并对 Vega-Lite 进行 主要 增量。

弃用#

NoneNone

弃用警告可能会在 主要次要 版本中引入,但弃用功能的移除不会发生,直至 至少 下一次 主要 版本。

对于触发主要版本的上游重大变更,我们可能会提供弃用警告,如果我们认为该变更特别具有破坏性。

从版本 5.4.0 开始,所有弃用警告 必须 指定:

  • 它们被引入的版本号

在可能的情况下,弃用警告 可能 指定:

  • 替代的函数/方法/参数/类以供使用

  • 对为什么必须进行此更改的解释

弃用的功能 可能 会从Vega-Altair文档中移除,如果有合适的替代品,并且我们认为同时包含这两者可能会让新用户感到困惑。