search

xianggebenben / GraphSL

Graph Source Localization Library
MIT License
8 stars 2 forks source link

[JOSS Review] Example Usage #14

Closed mbeyss closed 4 months ago

mbeyss commented 4 months ago

related to this JOSS Review

While you have a very nice example that shows how to use all of your algorithms it could really need some comments and structure. I would suggest turning this into a jupyter notebook, where you can better explain and show what you are doing.

xianggebenben commented 4 months ago

Thank you for the suggestion. We have added a jupyter notebook file tutorial.ipynb to explain the implementation.

mbeyss commented 4 months ago

That notebook is a good first step. What I hoped for was some added comments. Notebooks offer great ways of structuring and commenting code

xianggebenben commented 4 months ago

That notebook is a good first step. What I hoped for was some added comments. Notebooks offer great ways of structuring and commenting code

Thank you for the comment. The jupyter notebook file tutorial.ipynb is added with detailed comments of explanations. Please let me know if you have any questions.

mbeyss commented 4 months ago

I think the features of a notebook can be better employed. I created a pull request, to show what I mean. Have a look at #17

xianggebenben commented 4 months ago

I think the features of a notebook can be better employed. I created a pull request, to show what I mean. Have a look at #17

Thanks very much for your help. I have merged the pull request.