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

[docs] add known issues about near scope #1639

Merged

Conversation

takatea
Copy link
Contributor

@takatea takatea commented Dec 15, 2023

Thank you for your fantastic gem!

I met errors or a performance degradation when I tried to use Rails's pluck or select with the near scope of geocoder.
Finally, I found the solution with select option of near scope, but unfortunately it is not documented well in the README.
So, this PR adds descriptions for such cases.

By the way, I have some ideas to make select option more friendly for Rails users.
I will open issues for them.

README.md Outdated Show resolved Hide resolved
@alexreisner
Copy link
Owner

Thanks for this. It's very helpful. However, it's a lot of additional information, and I'm trying to keep the README as short as possible (it's already too long). Do you think we can get rid of the new sections and limit any additions to 10 lines? The problem is explained well enough on line 735, so I don't think we need the SQL examples. The most important things are the workarounds: the :select option on the near method and to_a.pluck. What if we just added the workarounds?

@takatea
Copy link
Contributor Author

takatea commented Dec 18, 2023

@alexreisner

Thanks for your review!
I did not realise the section you mentioned.
I agree to keep the README simple, and I will update this PR based on your feedback!

@takatea
Copy link
Contributor Author

takatea commented Dec 25, 2023

Hi, @alexreisner !

I fixed the document based on your suggestion, but it exceeds the 10-line limit slightly.
It seems we can remove the known issue related to includes (line774-792) . What do you think?

Please review, and let me know if any adjustments are needed!
Thanks in advance.

* Move known issues related to `near` and `select` to Troubleshooting.
* Add code examples for troubleshooting with ActiveRecord.
@takatea takatea force-pushed the add-known-issues-using-near-scope branch from b1debc0 to 995177b Compare December 25, 2023 04:53
@takatea
Copy link
Contributor Author

takatea commented Jan 12, 2024

@alexreisner

Hi there!
I pushed changes based on your feedback.
Could you review this updated PR?

@alexreisner
Copy link
Owner

Hi! Sorry, I lost track of this. It looks great. Thank you!

@alexreisner alexreisner merged commit c41b906 into alexreisner:master Jan 12, 2024
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.

3 participants