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

MONGOID-5614 Document ffi dependency #5615

Merged
merged 2 commits into from
May 8, 2023

Conversation

comandeo
Copy link
Contributor

@comandeo comandeo commented May 5, 2023

No description provided.

@comandeo comandeo requested review from jamis and alexbevi May 5, 2023 15:42
Copy link
Contributor

@jamis jamis left a comment

Choose a reason for hiding this comment

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

Just a formatting issue, and a grammar issue, but looks good otherwise!

Add ``ffi`` to your Gemfile
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Mongo Ruby driver uses `ffi gem <https://github.com/ffi/ffi>`_ to call
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like a stray underscore character here. Also, probably only need backticks around the word "ffi" itself.

Also, grammatically: I'd insert "the" before "Mongo" and after "uses" (e.g. "The Mongo Ruby driver uses the ffi gem...").

Copy link
Contributor

@alexbevi alexbevi May 5, 2023

Choose a reason for hiding this comment

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

I cleaned this up. The trailing underscore is restructuredText link syntax (these aren't markdown files)

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah! Right. I keep forgetting about that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the cleanup!

@comandeo comandeo merged commit 2af448c into mongodb:master May 8, 2023
@comandeo comandeo deleted the 5614-document-ffi branch May 8, 2023 07:16
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.

4 participants