search

ModECI / MDF

This repository contains the source for the MDF specification and Python API
https://mdf.readthedocs.io
Apache License 2.0
36 stars 69 forks source link

Missing Link to Functions List in Parameter Section in Documentation #515

Closed rimjhimittal closed 8 months ago

rimjhimittal commented 9 months ago

In the Parameters section of documentation here , in the allowed parameters table-> function field, the link to built-in MDF Functions is missing

image
rimjhimittal commented 9 months ago

do we have to use the same link as in Function section here?

pgleeson commented 8 months ago

To fix, properly indent this: https://github.com/ModECI/MDF/blob/067ff411eb04f8cb6771f631ea1cd86aafa24b49/src/modeci_mdf/mdf.py#L165-L166 like this: https://github.com/ModECI/MDF/blob/067ff411eb04f8cb6771f631ea1cd86aafa24b49/src/modeci_mdf/mdf.py#L67-L68

pgleeson commented 8 months ago

FYI @rimjhimittal this won't be fixed on the live docs until there is a merge of the development branch to main and a package release. But fine to close the issue for now.

rimjhimittal commented 8 months ago

Thank you for the clarification. I closed the issue because I believed it had been addressed. Looking forward to seeing the updates in action after the release! 🚀