docs improved

mocnik-science · Dec 7, 2021 · cdd0e99 · cdd0e99
1 parent 7946d99
commit cdd0e99
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs/nominatim.md b/docs/nominatim.md
@@ -106,6 +106,6 @@ In case of numerous requests, one may want to delay the requests. The fetching p
 ```python
 nominatim = Nominatim(waitBetweenQueries=2)
 ```
-Also combinations of `endpoint`, `cacheDir`, and `waitBetweenQueries` can be used.
+Also the parameters `endpoint` and `waitBetweenQueries` can be used.
 
 Further information about these parameters can be found on the [general remarks](general-remarks.md) page.
diff --git a/docs/overpass.md b/docs/overpass.md
@@ -64,7 +64,7 @@ from OSMPythonTools.overpass import Overpass
 overpass = Overpass()
 busStops = overpass.query(query)
 ```
-Please observe that the constructor of the class `Overpass` again accepts the parameters `endpoint`, `cacheDir`, and `waitBetweenQueries`.
+Please observe that the constructor of the class `Overpass` again accepts the parameters `endpoint` and `waitBetweenQueries`.
 To query historical data, we can easily add a date:
 ```python
 overpass.query(query, date='2014-01-01T00:00:00Z')

diff --git a/version-history.md b/version-history.md
@@ -2,7 +2,7 @@
 
 # Version History
 
-Observe that some of the following versions include breaking changes:
+Please note that versions may include breaking changes.
 
 ## Version v0.3.3
 
@@ -14,3 +14,7 @@ Observe that some of the following versions include breaking changes:
 * [bug] metadata did not work for Api queries
 * [minor bug] version was not returned as an integer
 * [minor bug] the method to access the Api version was overwritten by the method to access the element version
+
+Breaking changes:
+
+* The constructors of the classes `Api`, `Nominatim`, and `Overpass` do not accept the paramter `cacheDir` any longer.  Instead, the parameter needs to be provided to the method `CachingStrategy.use`.