Minor documentation improvements

jcornaz · Jul 1, 2019 · d6fb32a · d6fb32a
1 parent dc09184
commit d6fb32a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -32,17 +32,14 @@ Property-based testing library for Kotlin.
 
 .. startReferenceToDoc
 
-Find more information about setup_ and usage_ on https://kwik.readthedocs.io
-
-.. _setup: https://kwik.readthedocs.io/en/latest/setup.html
-.. _usage: https://kwik.readthedocs.io/en/latest/write-tests.html
+Find more information on https://kwik.readthedocs.io
 
 .. endReferenceToDoc
 
 Status
 ------
 
-The project is incubating and the API may evolve in the future.
+The project is incubating and its API is subject to changes.
 
 Please give it a try and write a feed back in the issues_ or discuss on gitter_
 
@@ -77,6 +74,7 @@ How it looks like
 For more information read the usage_ and look at the available generators_
 
 .. _generators: https://kwik.readthedocs.io/en/latest/built-in-generators.html
+.. _usage: https://kwik.readthedocs.io/en/latest/write-tests.html
 
 .. endUsageReference
 
@@ -115,4 +113,6 @@ Example of setup using gradle.
 
 Find more detailed information, read the setup_ instructions.
 
+.. _setup: https://kwik.readthedocs.io/en/latest/setup.html
+
 .. endReferenceToSetup
diff --git a/docs/setup.rst b/docs/setup.rst
@@ -10,7 +10,7 @@ So before being able to use Kwik you have to setup a test-engine for your projec
 If the project is for the JVM (Java), you probably want to use Junit_ or Spek_.
 
 .. note::
-    kotlintest_ provide a similar API than Kwik.
+    If you choose to use kotlintest_ as a test-engine, be aware that it includes a similar property-based testing API.
 
     In order to don't get confused by mixing the two libraries you may exclude the ``kotlintest-assertions`` artifact
     or introduce some rules in your IDE and/or linter to prevent usages of the package `io.kotlintest.properties`.