search

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

Fix Documentation Links #5

Closed es0329 closed 1 year ago

es0329 commented 1 year ago

:bulb: What’s this?

An edit to fix broken links in the backward-compatibility topic.

:pencil: What changed?

Replaced abbreviations/apostrophe with words.

IgnatBeresnev commented 1 year ago

The links indeed don't work when viewing the document on GitHub (and, I assume, when previewing it locally).

However, they work as expected in the published documentation.

I guess @PetrakovichVictoria can decide if we can accept the Don't -> Do not change to make a bit more GitHub friendly :)

PetrakovichVictoria commented 1 year ago

Hi! Unfortunately, not all the links with "don-t" were changed, so this PR actually breaks the project. If you find some time to change all the links that refer to changed headers, it will be possible to accept this PR. However, this text is also under a proofread now, I would wait for what they say and advise you not making more changes right now.

PetrakovichVictoria commented 1 year ago

Hi! A proofread of the whole project was done by our copyeditors. They decided not to change Don't to Do not. So, I close this pull request. However, thank you!