Documentation.md

+The documentation for PESumamry can be found here: https://lscsoft.docs.ligo.org/pesummary/index.html
+
+We read through the documentation to check that it is clear and easy to follow.
+
+The following are issues we found in the documentation:
+
+Installation Page (https://lscsoft.docs.ligo.org/pesummary/installation.html):
+ - Put the virtualenv creation example clearer on the page
+ - Make the created environment in the example have the same name as is later used
+
+Could you create a downloadable file so that people can run the examples themselves? 
+
+When and where functions are mentioned in the documentation could you add links to the git repository where that functions code is?
+
+Corner (https://lscsoft.docs.ligo.org/pesummary/summarypages/corner.html):
+- First line: [its] best features would read better
+- Video doesn’t work
+
+Config (https://lscsoft.docs.ligo.org/pesummary/summarypages/config.html):
+- No example of the config file is given when mentioned
+
+Comparison (https://lscsoft.docs.ligo.org/pesummary/summarypages/comparison.html):
+- Last plot, boxplots, example and example2 are the same colour (orange), example should be blue to be consistent with the above examples
+
+Comparison Interactive (https://lscsoft.docs.ligo.org/pesummary/summarypages/comparison_interactive.html):
+- Image is oversized
+- Plots overlap some text
+- This is the same for the interactive corner plot page (https://lscsoft.docs.ligo.org/pesummary/summarypages/interactive.html)
+
+Publication (https://lscsoft.docs.ligo.org/pesummary/summarypages/publication.html):
+- Note header at the bottom has a strange appearance
+
+Notes (https://lscsoft.docs.ligo.org/pesummary/summarypages/notes.html):
+- Missing image
+
+Examples (https://lscsoft.docs.ligo.org/pesummary/summarypages/examples.html):
+- The comparison pages, from the link at the bottom have strange layouts with plots an text overlapping
+
+Summarypages (https://lscsoft.docs.ligo.org/pesummary/executables/summarypages.html):
+- It would be good if you could give an example config file here
+
+Summary classification (https://lscsoft.docs.ligo.org/pesummary/executables/summaryclassification.html):
+- Some definitions missing at the bottom of this page
+
+Summarydetchar (https://lscsoft.docs.ligo.org/pesummary/executables/summarydetchar.html):
+- It would be good to have some example result images here
+- Could you give a slightly more detailed explanation of vmin and vmax
+
+GWTC-1 Plots (https://lscsoft.docs.ligo.org/pesummary/tutorials/GWTC1_plots.html):
+- The plots these create are not scaled so the results portion of the graph are quite small
+
+Scatterplot (https://lscsoft.docs.ligo.org/pesummary/tutorials/population_scatter_plot_GWTC-1.html):
+- This example gives the following error message:
+
+Traceback (most recent call last):
+  File "/home/philip.relton/virtualenvs/pesummary_pyenv3.7/bin/summarypublication", line 11, in <module>
+    load_entry_point('pesummary==0.3.2', 'console_scripts', 'summarypublication')()
+  File "/home/philip.relton/virtualenvs/pesummary_pyenv3.7/lib/python3.7/site-packages/pesummary-0.3.2-py3.7.egg/pesummary/cli/summarypublication.py", line 351, in main
+    func_map[opts.plot](opts)
+  File "/home/philip.relton/virtualenvs/pesummary_pyenv3.7/lib/python3.7/site-packages/pesummary-0.3.2-py3.7.egg/pesummary/cli/summarypublication.py", line 299, in make_population_scatter_plot
+    if not all(i in parameters[num] for i in opts.parameters):
+TypeError: 'NoneType' object is not iterable
+
+
+Related Merge Requests:
\ No newline at end of file