From cf6b2aab002c490e624b944000d91dc4eb2d0449 Mon Sep 17 00:00:00 2001 From: Jerry Pussinen Date: Tue, 3 Feb 2026 11:29:40 +0200 Subject: [PATCH] Fix malformed bullet points in GitHub Pages Add blank line before bullet point list to ensure proper markdown rendering. Without the blank line, the bullet points were rendered as literal asterisks inside a paragraph instead of as a proper list. Fixes #115 Co-Authored-By: Claude Opus 4.5 --- CHANGELOG.md | 2 ++ README.md | 1 + 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e4436a..1391dff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Fixed +- Fix malformed bullet points rendering in GitHub Pages documentation ## [0.11.0] - 2026-02-03 ### Added diff --git a/README.md b/README.md index fe40daa..03d30e2 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,7 @@ Each algorithm makes different tradeoffs, but generally `least_duration` should | least_duration | ❌ | ✅ | Better | ✅ | Explanation of the terms in the table: + * Absolute Order: whether each group contains all tests between first and last element in the same order as the original list of tests * Relative Order: whether each test in each group has the same relative order to its neighbours in the group as in the original list of tests * Works with random ordering: whether the algorithm works with test-shuffling tools such as [`pytest-randomly`](https://github.com/pytest-dev/pytest-randomly)