Add Documentation to all analyzers

[TheShiny1]

No description provided.

[enpuyou]

Hi @TheShiny1, can you provide a description of the issue you are raising? What kind of documentation are you considering? A documentation website like #33 suggests? Or documentation in the code?

[Mai1902]

Hi @enpuyou, our idea is somewhat similar to #33 since we want to add description to all analyzers and visualization. However, we want it to appear right on GatorMiner instead of developing a separated website. Do you think we should write description right on GatorMiner by adding a .txt file, scan through the file and print it under every analyzer by adding print command in visualization.py and summarizer.py or we should follow your idea of creating a website. I am so sorry that I asked it too late. But I do found the idea of writing a website is really nice.

[enpuyou]

@Mai1902 No worries! I think your idea is great and there is no need for creating another website. I do think you might wanna use markdown instead of txt, use st.write() instead of print(). Thanks!

[TheShiny1]

@enpuyou I misclicked, my bad