Skip to content

Commit

Permalink
docs: fix some typos and broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
sr-murthy committed Jun 10, 2024
1 parent 0322336 commit c4ab297
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 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,7 +153,7 @@ 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:

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

0 comments on commit c4ab297

Please sign in to comment.