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

Updating README.md as first commit #15

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

andreacate
Copy link

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.

Copy link
Contributor

@vfisikop vfisikop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@andreacate
Copy link
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!

@andreacate
Copy link
Author

Hi @vfisikop,
I tried to follow your guidelines while updating the documentation. If you would prefer a more detailed README explaining each example or any other improvements, please let me know!

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

Successfully merging this pull request may close these issues.

2 participants