dpalmasan / TRUNAJOD2.0

An easy-to-use library to extract indices from texts.
https://trunajod20.readthedocs.io/en/latest/
MIT License
29 stars 7 forks source link

Include additional examples on the documentation #51

Closed mbdemoraes closed 3 years ago

mbdemoraes commented 3 years ago

In the documentation, there is only one example of usage. Since there is a lot of features, the authors should include at least two or three more examples, using other features to improve the understanding of the proposed package. Currently, the remaining functionality is described only at an API level, which seems insufficient.

cc https://github.com/openjournals/joss-reviews/issues/3153

dpalmasan commented 3 years ago

Got it. I will include a more detailed example of usage. I will let you know when this is done!

dpalmasan commented 3 years ago

@mbdemoraes I included a code snippet showing how this can be used on research related to text analysis. I also provided a real application demo (as a youtube video) built on TRUNAJOD. Let me know if I need to improve anything else. Thanks for the review BTW!

mbdemoraes commented 3 years ago

@dpalmasan I've checked the new examples, thank you for including them. By the way, very good video!

Since the modification addressed the suggestion, I'm going to close the issue now.