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

Doc: updates following Rust compilation #231

Merged
merged 2 commits into from
May 3, 2024

Conversation

WardBrian
Copy link
Collaborator

This is a follow on to #212 with a few extra tweaks to the documentation.

@WardBrian WardBrian added the documentation Improvements or additions to documentation label May 1, 2024
@WardBrian WardBrian requested a review from roualdes May 1, 2024 20:53
Copy link
Owner

@roualdes roualdes left a comment

Choose a reason for hiding this comment

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

Definitely throwing some pedantry at you, here. I'd also be content if you ignore all my grammar suggestions.

If you do make some changes, would you also add the word can to the sentence

If you use BridgeStan in your research, please consider citing our JOSS paper and letting us know so we [can] list your project here.

in the Section Research using BridgeStan of bridgestan/README.md?

docs/index.rst Outdated Show resolved Hide resolved


Additional "quality of life" features are available on a best-effort basis.
If you are missing a feature from one interface in your favorite language, we would welcome a
Copy link
Owner

Choose a reason for hiding this comment

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

If you are missing a feature from one interface in your favorite language, we would welcome a contribution

Can we drop the word would?

I'm also hesitant about the word one. Maybe the? Other thoughts?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Rewrote the whole sentence to "If BridgeStan's bindings to your favorite language are missing one of these features, we welcome contributions!"

docs/languages/rust.rst Show resolved Hide resolved
@bob-carpenter
Copy link
Collaborator

Just stopping by to say I approve of the level of grammatical pedantry on both sides! If you want one more, I don't like "Note that" because it's redundant.

And yes please on the citation nudge.

@WardBrian WardBrian merged commit a566ce5 into main May 3, 2024
19 checks passed
@WardBrian WardBrian deleted the docs/rust-compilation-updates branch May 3, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants