diff --git a/docs/_api/dataframely.columns.rst b/docs/_api/dataframely.columns.rst index bc990c3..e6fa538 100644 --- a/docs/_api/dataframely.columns.rst +++ b/docs/_api/dataframely.columns.rst @@ -17,6 +17,14 @@ dataframely.columns.any module :show-inheritance: :undoc-members: +dataframely.columns.array module +-------------------------------- + +.. automodule:: dataframely.columns.array + :members: + :show-inheritance: + :undoc-members: + dataframely.columns.bool module ------------------------------- @@ -73,6 +81,14 @@ dataframely.columns.list module :show-inheritance: :undoc-members: +dataframely.columns.object module +--------------------------------- + +.. automodule:: dataframely.columns.object + :members: + :show-inheritance: + :undoc-members: + dataframely.columns.string module --------------------------------- diff --git a/docs/index.rst b/docs/index.rst index c3436de..aad488d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,7 +29,7 @@ Contents Real-world Example FAQ Development Guide - + Versioning API Documentation ================= diff --git a/docs/sites/development.rst b/docs/sites/development.rst index b184b6a..464e77d 100644 --- a/docs/sites/development.rst +++ b/docs/sites/development.rst @@ -42,6 +42,7 @@ documentation and then open it in your web browser using the commands below: .. code-block:: bash # Run build + pixi run -e docs postinstall pixi run docs # Open documentation diff --git a/docs/sites/versioning.rst b/docs/sites/versioning.rst new file mode 100644 index 0000000..ecf0fe3 --- /dev/null +++ b/docs/sites/versioning.rst @@ -0,0 +1,20 @@ +Versioning policy and breaking changes +====================================== + +Dataframely uses `semantic versioning `_. +This versioning scheme is designed to make it easy for users to anticipate what types of change they can expect from a given version update in their dependencies. +We generally recommend that users take measures to control dependency versions. Personally, we like to use ``pixi`` as a package manager, which comes with builtin +support for lockfiles. Many other package managers support similar functionality. When updating the lockfiles, we recommend to use automated testing +to ensure that user code still works with newer versions of dependencies such as ``dataframely``. + +Most importantly, semantic versioning implies that breaking changes of user-facing functionality are only introduced in **major releases**. +We therefore recommend that users are particularly vigilant when updating their environments to a newer major release of `dataframely`. +As always, automated testing is useful here, but we also recommend checking the release notes `published on GitHub `_. + +In order to give users a heads-up before breaking changes are released, we introduce `FutureWarnings `_ . +Warnings are the most direct and effective tool at our disposal for reaching users directly. +We therefore generally recommend that users do not silence such warnings explicitly, but instead migrate their code proactively, whenever possible. +However, we also understand that the need for migration may catch users at an inconvenient time, and a temporary band aid solution might be required. +Users can disable ``FutureWarnings`` either through `python builtins `_, +builtins from tools like `pytest `_ , +or by setting the ``DATAFRAMELY_NO_FUTURE_WARNINGS`` environment variable to ``true`` or ``1``.