Some minor style nitpicks

Kotlin / api-guidelines

Best practices to consider when writing an API for your library

https://kotl.in/api-guide

Apache License 2.0

145 stars 20 forks source link

Some minor style nitpicks #12

Closed elizarov closed 1 year ago

elizarov commented 1 year ago

Reduce overuse of the word "some". In many cases it is not needed or should be replaced with an indefinite article.
Use expression body in code examples whenever possible so that code examples are shorter, thus easier to read and more idiomatic.
Evaluative adverbs like "unfortunately" do not fit the style of documentation. It is better to simply state the facts. "unfortunately no workaround" -> "no workaround".
Typography: replace "-" (minus sign) with mdash.

asm0dey commented 1 year ago

@elizarov thank you for the contribution! We will send your changes to our copyeditors and will update the text as soon as they will approve!

PetrakovichVictoria commented 1 year ago

@elizarov thank you for the contribution! We will send your changes to our copyeditors and will update the text as soon as they will approve!

@elizarov, thank you! I copied your changes to our doc with this text that is under copyediting now. We can merge these changes. Just a couple of comments from my side.