[docs] Add warning about SemVer in release notes

gmzang · Mar 3, 2020 · cdf4187 · cdf4187
1 parent 0097ef5
commit cdf4187
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 35 deletions.
diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -1,6 +1,11 @@
 Release notes
 =============
 
+Please note that Mitsuba 2 being a research framework, it will not strictly follow the
+`Semantic Versionning <https://semver.org/>`_ convention. There will be frequent API changes and
+those should be well documented in the release notes below.
+
+
 Incoming release
 ----------------
 

diff --git a/docs/src/advanced_topics/diffuse_bsdf.rst b/docs/src/advanced_topics/diffuse_bsdf.rst
diff --git a/docs/src/plugin_reference/section_shape.rst b/docs/src/plugin_reference/section_shape.rst
@@ -19,7 +19,7 @@ Shapes are usually declared along with a surface scattering model named *BSDF* (
         <shape type=".. shape type ..">
             .. shape parameters ..
 
-            <bsdf type-".. BSDF type ..">
+            <bsdf type=".. BSDF type ..">
                 .. bsdf parameters ..
             </bsdf>