search

amepproject / amep

The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
https://amepproject.de/
GNU General Public License v3.0
11 stars 2 forks source link

DOC: incorrectly rendered code in evaluate.LDdist doc #12

Closed hechtprojects closed 5 months ago

hechtprojects commented 6 months ago

Problem description:

https://amepproject.de/_autosummary/amep.evaluate.LDdist.html

Inline code in the description and the code block in the "Notes" section are not rendered correctly.

Suggested content improvement:

Change the doc string of amep.evaluate.LDdist accordingly.

hechtprojects commented 5 months ago

The updated documentation will be part of patch release v1.0.1.