Open
Conversation
vfisikop
reviewed
Feb 13, 2025
vfisikop
left a comment
There was a problem hiding this comment.
Thanks for opening this PR!
As it is now it is not ready to be merged.
Some points that needs improvements or could help to create a more useful README:
- The installation section does not give a lot of information. Only how to clone the repository which is very generic. It could include a basic example and/or how to run a test.
- There is no connection between features and examples for the reader/user to understand what the library is doing. Some background is missing, e.g. how optimization and ML is used for index replication.
Author
|
Thank you for the helpful feedback! I will work on these improvements in the coming days. I am also working on docstrings documentation and I was wondering if is it possible that some notebooks in the folder example might have some bugs, thanks! |
Author
|
Hi @vfisikop, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I came across your open-source project GeomScale and I explored the repositories. I find the project interesting, this is my first pull request for improving the documentation of PorQua.