search

sjvrijn / mf2

Collection of Multi-Fidelity benchmark functions
https://mf2.readthedocs.io/
GNU General Public License v3.0
25 stars 7 forks source link

Fix typo in getting started doc #6

Closed zbeekman closed 4 years ago

zbeekman commented 4 years ago

The .ndim attribute did not have a leading period like the other attributes in the documentation did.

Furthermore, at first I found the wording somewhat confusing for the description of ndim. I think it would be helpful to state somewhere in the getting started documentation the more formal mathematical definition of the MF functions. Something like: "Each mf2 function maps a real valued input vector to a real valued scalar" or something similar. However, perhaps I'm just being slow.

EDIT I also pushed commits to make the RTD sphinx docs match the README file for installation instructions. Please NOTE: I did not test the conda installation from the conda-forge channel You may want to double check this works as expected, but I don't see why it wouldn't. I did test installing from a git clone and from PyPI in a venv and everything whent smoothly.

sjvrijn commented 4 years ago

Thanks for spotting those, seems I forgot to update the docs when I updated the instructions in the readme 😅