OpenSMFS / FRETBursts

Burst analysis software for single and multi-spot single-molecule FRET (smFRET) data.
https://opensmfs.github.io/FRETBursts/
GNU General Public License v2.0
13 stars 9 forks source link

Fix broken link in installation.rst #32

Closed mayeshh closed 4 years ago

mayeshh commented 4 years ago

There is a broken link in the installation.rst doc file. Assuming I am pointing to the correct website, I have adjusted the file accordingly.

Practicing PRs (pretty insignificant suggestion).

tritemio commented 4 years ago

Nothing is insignificant. Everybody needs to start from somewhere.

PR is good. As you can see tests fail, but is not your fault. I encourage to go and look at the log of the failing tests. The environment used by the CI tests is created fresh every time. Most packages are not pinned to a version, and in this case the latest matplotlib version breaks the tests due to removal of normpdf, as reported in #30. The fail is at import time, before the tests start running. This is the most common cause of test breakage, especially for trivial PR.

So, I am merging this.

You can monitor the building of the docs (see logs and errors) at this RTD page:

https://readthedocs.org/projects/fretbursts/

Docs are built for the latest release (called stable on RTD) and for the latest master (latest on RTD). Also to build docs we recreate and env and install FRETBursts, so we may have the same failure, unless matplotlib is pinned. I'll now merge to see what happens.

mayeshh commented 4 years ago

Thank you for the explanation. I saw that there might be a conflict but did not understand why.

Leaving the fork open to work on a solution for the removal of normpdf.