File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11.. toctree ::
22 :maxdepth: 2
33
4+ versioning.rst
45 assign_wcs/index.rst
56 associations/index.rst
67 dark_current/index.rst
Original file line number Diff line number Diff line change 1+ .. _romancal-version-scheme :
2+
3+ Versioning Scheme
4+ -----------------
5+
6+ .. note ::
7+
8+ This section addresses the release version to PyPI.
9+ It is not to be confused with the DMS quarterly build version,
10+ which has a different numbering scheme (see
11+ `software vs. DMS builds <https://github.com/spacetelescope/romancal/blob/main/README.md#software-vs-dms-build-version-map >`_).
12+
13+ The ``romancal `` package follows `semantic versioning <https://semver.org/ >`_ with a few minor
14+ exceptions noted below. In brief this means that backwards incompatible changes are allowed
15+ in major version changes, minor versions can contain new features and patch versions
16+ can contain only bug fixes.
17+
18+ .. _romancal-public-vs-private-api :
19+
20+ API: Public vs Private
21+ ----------------------
22+
23+ As per Python convention, any API name that starts with underscore
24+ (e.g., ``_my_private_function ``) is considered private.
25+ Any API not officially documented (i.e., you only found it after some extensive
26+ code-diving) is also considered private.
27+
28+ Additionally test code is considered private. This includes:
29+
30+ * all ``conftest.py `` files
31+ * modules that start with ``test_* `` or are named ``tests ``
32+ * everything under ``romancal.regtest ``
33+
34+ If there is code that you would like to be public, please search
35+ the open `issues <https://github.com/spacetelescope/romancal/issues >`_ and
36+ open a new one describing what you would like to be made public.
You can’t perform that action at this time.
0 commit comments