Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
rimjhimittal opened this issue Mar 15, 2024 · 4 comments
Closed
Labels
good first issue Good for newcomers

Comments

@rimjhimittal
Copy link
Contributor

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
Copy link
Contributor Author

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

@pgleeson pgleeson added the good first issue Good for newcomers label Mar 21, 2024
@pgleeson
Copy link
Member

To fix, properly indent this:

MDF/src/modeci_mdf/mdf.py

Lines 165 to 166 in 067ff41

function: Which of the in-build MDF functions (linear etc.) this uses, See
https://mdf.readthedocs.io/en/latest/api/MDF_function_specifications.html

like this:
function: Which of the in-build MDF functions (:code:`linear`, etc.). See supported functions:
https://mdf.readthedocs.io/en/latest/api/MDF_function_specifications.html

rimjhimittal added a commit to rimjhimittal/MDF that referenced this issue Mar 21, 2024
rimjhimittal added a commit to rimjhimittal/MDF that referenced this issue Mar 21, 2024
rimjhimittal added a commit to rimjhimittal/MDF that referenced this issue Mar 21, 2024
pgleeson added a commit that referenced this issue Mar 22, 2024
@pgleeson
Copy link
Member

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
Copy link
Contributor Author

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! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants