Skip to content

Commit 1596598

Browse files
committed
Update API-related documentation in Versioning Policy
This PR updates API-related documentation in Versioning Policy. It is an API when it is documented - we intentionally do not document some. Author: Hyukjin Kwon <[email protected]> Closes #597 from HyukjinKwon/update-api-policy1.
1 parent 17edd03 commit 1596598

File tree

2 files changed

+4
-10
lines changed

2 files changed

+4
-10
lines changed

site/versioning-policy.html

+2-5
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,8 @@ <h3>Alpha components</h3>
187187

188188
<h3>API compatibility</h3>
189189

190-
<p>An API is any public class or interface exposed in Spark that is not marked as &#8220;developer API&#8221; or
191-
&#8220;experimental&#8221;. Release A is API compatible with release B if code compiled against release A
192-
<em>compiles cleanly</em> against B. Currently, does not guarantee that a compiled application that is
193-
linked against version A will link cleanly against version B without re-compiling. Link-level
194-
compatibility is something we&#8217;ll try to guarantee in future releases.</p>
190+
<p>In general, An API is any public class or interface documented in Spark, e.g., <a href="https://spark.apache.org/docs/latest/api/scala/org/apache/spark/index.html">ScalaDoc</a>.
191+
We try to guarantee both source compatibility and binary compatibility between releases.</p>
195192

196193
<p>Note, however, that even for features &#8220;developer API&#8221; and &#8220;experimental&#8221;, we strive to maintain
197194
maximum compatibility. Code should not be merged into the project as &#8220;experimental&#8221; if there is

versioning-policy.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,8 @@ try to. Once they are marked "stable" they have to follow these guidelines.
3939

4040
<h3>API compatibility</h3>
4141

42-
An API is any public class or interface exposed in Spark that is not marked as "developer API" or
43-
"experimental". Release A is API compatible with release B if code compiled against release A
44-
_compiles cleanly_ against B. Currently, does not guarantee that a compiled application that is
45-
linked against version A will link cleanly against version B without re-compiling. Link-level
46-
compatibility is something we'll try to guarantee in future releases.
42+
In general, An API is any public class or interface documented in Spark, e.g., <a href="https://spark.apache.org/docs/latest/api/scala/org/apache/spark/index.html">ScalaDoc</a>.
43+
We try to guarantee both source compatibility and binary compatibility between releases.
4744

4845
Note, however, that even for features "developer API" and "experimental", we strive to maintain
4946
maximum compatibility. Code should not be merged into the project as "experimental" if there is

0 commit comments

Comments
 (0)