ISISNeutronMuon / MDANSE

MDANSE: Molecular Dynamics Analysis for Neutron Scattering Experiments
https://www.isis.stfc.ac.uk/Pages/MDANSEproject.aspx
GNU General Public License v3.0
21 stars 5 forks source link

Enhance Explanations in the "Glossary of Parameters" Section #269

Open ashmeigh opened 10 months ago

ashmeigh commented 10 months ago

The "Glossary of Parameters" section in the "mdanse" documentation plays a crucial role in helping users understand the terminology and parameters used within the software. To improve user comprehension and usability, this issue aims to enhance the explanations in the "Glossary of Parameters" section.

Proposed Changes:

Review and assess the current content in the "Glossary of Parameters" section. Identify areas where explanations may lack clarity, require additional detail, or could benefit from examples. Enhance the explanations by: Providing clear and concise definitions for each parameter. Offering relevant examples or use cases to illustrate how each parameter is used.