From b99e63f572d6085b4ab9f8f9141a3878b41b4948 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Fri, 8 May 2026 17:23:58 +0100 Subject: [PATCH] docs: render __Contents__ blocks as Markdown lists MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Without bullet markers, GitHub and JupyterLab collapse the contents block into one paragraph in the generated notebook's first markdown cell. Prefixing each `**Section:**` line with `- ` makes it render as a list. Continuation lines are indented two spaces so they belong to the same list item. Text-only edit inside top-level module docstrings — no Python or notebook execution change. Refs: https://github.com/PyAutoLabs/autolens_workspace/issues/138 --- .../model_composition/model_composition.py | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/scripts/model_composition/model_composition.py b/scripts/model_composition/model_composition.py index 1f3a8d5..63e44e4 100644 --- a/scripts/model_composition/model_composition.py +++ b/scripts/model_composition/model_composition.py @@ -19,16 +19,16 @@ __Contents__ -**Basic Model Composition:** af.Model and af.Collection with multiple components. -**Prior Linking:** Shared priors via object identity, cross-component links. -**Nested Collections:** Multi-level af.Collection nesting and cross-collection linking. -**Prior Types:** Uniform, Gaussian, TruncatedGaussian, LogUniform — type assertions. -**Fixed Parameters:** Constants reduce prior count. -**Parameter Vector Ordering:** prior_tuples_ordered_by_id, instance_from_vector, unit vectors. -**Serialization Round-Trip:** dict/from_dict preserves prior count, identity, types, paths. -**Identifier Stability:** Deterministic md5 hash; changes with structure or prior bounds. -**Model Subsetting:** with_paths, without_paths filtering. -**Model Assertions:** add_assertion raises FitException on invalid vectors. +- **Basic Model Composition:** af.Model and af.Collection with multiple components. +- **Prior Linking:** Shared priors via object identity, cross-component links. +- **Nested Collections:** Multi-level af.Collection nesting and cross-collection linking. +- **Prior Types:** Uniform, Gaussian, TruncatedGaussian, LogUniform — type assertions. +- **Fixed Parameters:** Constants reduce prior count. +- **Parameter Vector Ordering:** prior_tuples_ordered_by_id, instance_from_vector, unit vectors. +- **Serialization Round-Trip:** dict/from_dict preserves prior count, identity, types, paths. +- **Identifier Stability:** Deterministic md5 hash; changes with structure or prior bounds. +- **Model Subsetting:** with_paths, without_paths filtering. +- **Model Assertions:** add_assertion raises FitException on invalid vectors. """ import autofit as af