Skip to content

Commit

Permalink
Release v0.14.2 (#100)
Browse files Browse the repository at this point in the history
* chore: bump version refs to `0.14.2`

* docs: fix some typos and broken links
  • Loading branch information
sr-murthy committed Jun 11, 2024
1 parent 6ca4af9 commit 298278f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ keywords:
- real numbers

license: MPL-2.0
version: 0.14.1
date-released: 2024-06-10
version: 0.14.2
date-released: 2024-06-11

6 changes: 3 additions & 3 deletions docs/sources/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Tests :fas:`microscope`

Tests are defined in the :file:`tests` folder, and should be run with `pytest <https://pytest-cov.readthedocs.io/en/latest/>`_.

For convenience different types of test targets are defined in the `Makefile <Makefile>`_: ``lint`` for Ruff linting, ``doctests`` for running
For convenience different types of test targets are defined in the `Makefile <https://github.com/sr-murthy/continuedfractions/blob/main/Makefile>`_: ``lint`` for Ruff linting, ``doctests`` for running
`doctests <https://docs.python.org/3/library/doctest.html>`_ and ``unittests`` for running unittests and measuring coverage, using
``pytest`` and the ``pytest-cov`` plugin:

Expand Down Expand Up @@ -153,14 +153,14 @@ or via `PDM <https://pdm.fming.dev/latest/>`_:
CI/CD :fas:`circle-play`
========================

The CI/CD pipelines are defined in the `CI YML <.github/workflows/ci.yml>`_, and pipelines for all branches include a tests stage, consisting of Ruff linting, Python doctests, and unit tests, in that order. This will be amended in the future to ensure that tests are only run on updates to PRs targeting ``main``, to avoid duplication on ``main``.
The CI/CD pipelines are defined in the `CI YML <https://github.com/sr-murthy/continuedfractions/blob/main/.github/workflows/ci.yml>`_ and the `CodeQL Analysis YML <https://github.com/sr-murthy/continuedfractions/blob/main/.github/workflows/codeql-analysis.yml>`_, and pipelines for all branches include a tests stage, consisting of Ruff linting, Python doctests, and unit tests, in that order. This will be amended in the future to ensure that tests are only run on updates to PRs targeting ``main``, to avoid duplication on ``main``.

.. _contributing.versioning-and-releases:

Versioning and Releases :fas:`upload`
=====================================

The `PyPI package <https://pypi.org/project/continuedfractions/>`_ is currently at version ``0.14.1`` - the goal is to use `semantic versioning <https://semver.org/>`_ consistently for all future releases, but some earlier releases do not comply with strict semantic versioning.
The `PyPI package <https://pypi.org/project/continuedfractions/>`_ is currently at version ``0.14.2`` - the goal is to use `semantic versioning <https://semver.org/>`_ consistently for all future releases, but some earlier releases do not comply with strict semantic versioning.

There is currently no dedicated pipeline for releases - both `GitHub releases <https://github.com/sr-murthy/continuedfractions/releases>`_ and `PyPI packages <https://pypi.org/project/continuedfractions>`_ are published manually, but both have the same version tag.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/creating-continued-fractions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ For rational numbers :py:meth:`~continuedfractions.continuedfraction.ContinuedFr
In-place Extension by New/Additional Elements
---------------------------------------------

The :py:meth:`~continuedfractions.continuedfraction.ContinuedFraction.extend` instance method can be used to perform an in-place extension of the sequence of elements of a :py:class:`~continuedfractions.continuedfraction.ContinuedFraction` instance from new (or additional) sequence of elements - the new elements are added to the tail in the given order. Some examples are given below.
The :py:meth:`~continuedfractions.continuedfraction.ContinuedFraction.extend` instance method can be used to perform an in-place extension of the sequence of elements of a :py:class:`~continuedfractions.continuedfraction.ContinuedFraction` instance from new elements - the new elements are added to the tail in the given order. Some examples are given below.

.. code:: python
Expand Down
2 changes: 1 addition & 1 deletion src/continuedfractions/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.14.1"
__version__ = "0.14.2"

0 comments on commit 298278f

Please sign in to comment.