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

Update package descriptions and some links in docs #587

Merged
merged 10 commits into from
Jan 31, 2020

Conversation

karenswry
Copy link
Contributor

@karenswry karenswry commented Jan 30, 2020

Ruby gems and iOS pods-related changes + a touch of T1345 (slight changes in bug report and pull request templates).

Checklist

  • Change is covered by automated tests
  • The coding guidelines are followed
  • Example projects and code samples are updated (in case of API changes)

Had a lengthy conversation with native English speaking tech writers about "needed vs necessary" recently. It's much better to use "necessary" in such situations as it is as a legit adjective and "needed" is perceived as a verb forced to act as an adjective in their eyes. That's not a set-in-stone rule, but "necessary" is just better here.
@ilammy ilammy added the docs 📚 Documentation, both offline and online label Jan 30, 2020
Copy link
Collaborator

@ilammy ilammy left a comment

Choose a reason for hiding this comment

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

Looks cool, thank you 👍

(I'd probably drop “and wrappers” in all of the “...and has a unified API and wrappers across 12 platforms” since the users are probably not that interested in our internal lingo of wrapper/binding/library/extension, but “unified API across 12 platforms” reads as something substantial. Just my 2¢)

P.S. One day I'll get GitHub Actions CI done and README edits won't trigger full repository rebuild...

@karenswry
Copy link
Contributor Author

Thank you for the review! Hmm, I could be biased, too as I keep seeing the word "wrapper" with the very same meaning that we attach to it, across numerous unrelated projects.
And yes, introducing minor doc updates without giving everyone this much trouble would be super cool. But we use what we have.

themis.podspec Outdated Show resolved Hide resolved
Copy link
Contributor

@vixentael vixentael left a comment

Choose a reason for hiding this comment

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

@karenswry do you plan to add anything to this PR, or we can merge it?

@karenswry
Copy link
Contributor Author

Done here. Please merge.

@vixentael vixentael merged commit 4050709 into master Jan 31, 2020
@vixentael vixentael deleted the karenswry-external-readmes branch January 31, 2020 22:52
@vixentael vixentael changed the title Karenswry external readmes Update package descriptions and some links in docs Feb 5, 2020
@vixentael vixentael added W-ObjCThemis 🎨 Wrapper: ObjCThemis, Objective-C API W-RbThemis ♦️ Wrapper: RbThemis, Ruby API, Ruby gems labels Feb 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📚 Documentation, both offline and online W-ObjCThemis 🎨 Wrapper: ObjCThemis, Objective-C API W-RbThemis ♦️ Wrapper: RbThemis, Ruby API, Ruby gems
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants