From 586ce46c9ad6686b5328a99623ee4698f202eff0 Mon Sep 17 00:00:00 2001 From: MuhammadAziz032 <144066930+MuhammadAziz032@users.noreply.github.com> Date: Tue, 31 Mar 2026 15:37:48 +0100 Subject: [PATCH] Refine documentation section in README.md ## Summary This PR improves the Documentation section in the README by: - fixing inconsistent bullet formatting, - simplifying line breaks, - and improving wording for clarity. ## Motivation This change enhances readability and consistency for users and contributors exploring the API documentation. --- README.md | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e10834765..9021b4ab7 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,15 @@ pip install malariagen-data ## Documentation -Documentation of classes and methods in the public API are available -from the following locations: - -- [Ag3 API - docs](https://malariagen.github.io/malariagen-data-python/latest/Ag3.html) - -- [Af1 API - docs](https://malariagen.github.io/malariagen-data-python/latest/Af1.html) - -- [Amin1 API - docs](https://malariagen.github.io/malariagen-data-python/latest/Amin1.html) - -- [Adir1 API - docs](https://malariagen.github.io/malariagen-data-python/latest/Adir1.html) - -- [Pf8 API - docs](https://malariagen.github.io/parasite-data/pf8/api.html) - -- [Pf7 API - docs](https://malariagen.github.io/parasite-data/pf7/api.html) - -- [Pv4 API - docs](https://malariagen.github.io/parasite-data/pv4/api.html) +Documentation for classes and methods in the public API is available at the following locations: + +- [Ag3 API docs](https://malariagen.github.io/malariagen-data-python/latest/Ag3.html) +- [Af1 API docs](https://malariagen.github.io/malariagen-data-python/latest/Af1.html) +- [Amin1 API docs](https://malariagen.github.io/malariagen-data-python/latest/Amin1.html) +- [Adir1 API docs](https://malariagen.github.io/malariagen-data-python/latest/Adir1.html) +- [Pf8 API docs](https://malariagen.github.io/parasite-data/pf8/api.html) +- [Pf7 API docs](https://malariagen.github.io/parasite-data/pf7/api.html) +- [Pv4 API docs](https://malariagen.github.io/parasite-data/pv4/api.html) ## Release notes (change log)