jjhelmus / nmrglue

A module for working with NMR data in Python
BSD 3-Clause "New" or "Revised" License
211 stars 86 forks source link

Updates to the documentation #129

Closed kaustubhmote closed 3 years ago

kaustubhmote commented 3 years ago

This PR updates the documentation at these places:

  1. New functions in fileio.simpson.py and fileio.bruker.py catalogued
  2. A new file for documenting misc.xcpy.py
  3. Updated installation instructions and requirements (install.rst)
  4. Updated tutorial.rst (correct links, more information on filetypes that nmrglue can handle)
  5. Updated instructions to use matplotllib in tutorial.rst
kaustubhmote commented 3 years ago

There are several other places where the documentation needs to be updated, and I'll get to those eventually. But this is what I already had ready, and since the plan is to cut version 0.8 soon, these could possibly go in.

jjhelmus commented 3 years ago

Thanks for putting this together. Looks good overall. I added two comments on minor changes.

jjhelmus commented 3 years ago

LGTM, thanks for the update.