update note on previously undocumented breaking changes

update docs
raszi · Aug 26, 2022 · d6be356 · d6be356
1 parent 31bf774
commit d6be356
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,14 @@ All breaking changes that had been introduced, i.e.
 have been reverted in v0.2.2 and tmp should now behave as it did before the
 introduction of these breaking changes.
 
+Other breaking changes, i.e.
+
+- template must not include any path components
+- name must be relative to tmpdir
+- dir option must be relative to tmpdir
+
+are still in place.
+
 In order to override the system's tmpdir, you will have to use the newly
 introduced tmpdir option.
 

diff --git a/docs/global.html b/docs/global.html
@@ -3510,7 +3510,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 21:08:17 GMT+0200 (Mitteleuropäische Sommerzeit)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 22:10:07 GMT+0200 (Mitteleuropäische Sommerzeit)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -72,6 +72,13 @@ <h2>An Important Note on Previously Undocumented Breaking Changes</h2>
 </ul>
 <p>have been reverted in v0.2.2 and tmp should now behave as it did before the
 introduction of these breaking changes.</p>
+<p>Other breaking changes, i.e.</p>
+<ul>
+<li>template must not include any path components</li>
+<li>name must be relative to tmpdir</li>
+<li>dir option must be relative to tmpdir</li>
+</ul>
+<p>are still in place.</p>
 <p>In order to override the system's tmpdir, you will have to use the newly
 introduced tmpdir option.</p>
 <h2>An Important Note on Compatibility</h2>
@@ -331,7 +338,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 21:08:17 GMT+0200 (Mitteleuropäische Sommerzeit)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 22:10:07 GMT+0200 (Mitteleuropäische Sommerzeit)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/tmp.js.html b/docs/tmp.js.html
@@ -807,7 +807,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 21:08:17 GMT+0200 (Mitteleuropäische Sommerzeit)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Aug 26 2022 22:10:07 GMT+0200 (Mitteleuropäische Sommerzeit)
 </footer>
 
 <script> prettyPrint(); </script>