Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include additional examples on the documentation #51

Closed
mbdemoraes opened this issue Apr 15, 2021 · 3 comments
Closed

Include additional examples on the documentation #51

mbdemoraes opened this issue Apr 15, 2021 · 3 comments
Assignees

Comments

@mbdemoraes
Copy link

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 openjournals/joss-reviews#3153

@dpalmasan
Copy link
Owner

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

@dpalmasan dpalmasan self-assigned this Apr 15, 2021
@dpalmasan
Copy link
Owner

@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
Copy link
Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants