PMEAL / OpenPNM

A Python package for performing pore network modeling of porous media
http://openpnm.org
MIT License
442 stars 175 forks source link

Convert all "lists of options" into tables #2236

Closed jgostick closed 2 years ago

jgostick commented 2 years ago

At present we have modes and other optional things as bullet point lists. Let's convert them all to markdown tables.

Here is the good way

Here is the old way

ma-sadeghi commented 2 years ago

Hi, @nik23130: I compiled the list of files you need to go through:

OpenPNM/openpnm/algorithms/_advection_diffusion.py
OpenPNM/openpnm/algorithms/_generic_transport.py
OpenPNM/openpnm/algorithms/_ordinary_percolation.py
OpenPNM/openpnm/algorithms/_reactive_transport.py
OpenPNM/openpnm/core/_base.py
OpenPNM/openpnm/core/_mixins.py
OpenPNM/openpnm/core/_models.py
OpenPNM/openpnm/models/misc/neighbor_lookups.py
OpenPNM/openpnm/models/physics/meniscus.py
OpenPNM/openpnm/models/physics/multiphase.py
OpenPNM/openpnm/network/_bravais.py
OpenPNM/openpnm/network/_generic.py
OpenPNM/openpnm/phases/_multiphase.py
OpenPNM/openpnm/phases/mixtures/_generic_mixture.py
OpenPNM/openpnm/physics/_generic.py
OpenPNM/openpnm/topotools/_perctools.py
OpenPNM/openpnm/topotools/_topotools.py
OpenPNM/openpnm/topotools/generators/_bcc.py
OpenPNM/openpnm/topotools/generators/_fcc.py
OpenPNM/openpnm/topotools/generators/tools.py