Clean up and documentation
jmcq89 opened this issue · 1 comments
- in SpectralEmbedding the citations are out of date -- to update
- example.py, dev_example.py, /benchmarkes/ & /astrodemo/ should be removed.
- turn example.py into an iPython tutorial that we can host on the website. Perhaps we can do this as we teach the API to Grace?
- The example usage & non-auto doc documentation for: Geometry, Adjacency, Laplacian, Affinity & all the embeddings need to be fixed with respect to new API changes.
- The sphinx build needs to be re-run when API changes are made.
- Add some example plots to the website
Should we move covar_plotter.py somewhere inside the package?
Dear all, I thought of this several times, and decided not to. Because
this function is not really integrated with the package, it's just an
expedient we use for convenience. If we ever write a visualization module,
then it should belong there. But for now,given that there is no other
postprocessing or visualization functionality there, I think we can leave
it out.
Marina
On 3/4/16, 9:27 AM, "James McQueen" notifications@github.com wrote:
@jakevdp https://github.com/jakevdp
@mmp2 https://github.com/mmp2
-[ ] Should we move covar_plotter.py somewhere inside the package? Should
consider writing an example using it as well.
-[ ] example.py & dev_example.py should be removed. Should turn
example.py into an iPython tutorial that we can host on the website --
perhaps we can do this as we teach the API to Grace?
-[ ] examples/ and astrodemo/ should be removed and replaced with the
example from the previous step
-[ ] The example usage & non-auto doc documentation for: Geometry,
Adjacency, Laplacian, Affinity & all the embeddings need to be fixed with
respect to new API changes.
-[ ] The sphinx build needs to be re-run when API changes are made.
-[ ] Add some example plots to the website
�
Reply to this email directly or
view it on GitHub #25.