Rename free to release and deprecate free

TheZoq2 · TheZoq2 · commit ae870eb7d818 · 2020-06-24T22:22:05.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - Use `Deref` for I2C generic implementations instead of macros
+- Deprecate `Spi::free` and rename it to `Spi::release`
+- Improve `SPI` documentation
 
 ## [v0.6.0] - 2020-06-06
 
diff --git a/src/spi.rs b/src/spi.rs
@@ -303,9 +303,13 @@ where
         }
     }
 
+    #[deprecated(since = "0.6.0", note = "Please use release instead")]
     pub fn free(self) -> (SPI, PINS) {
         (self.spi, self.pins)
     }
+    pub fn release(self) -> (SPI, PINS) {
+        self.free()
+    }
 }
 
 impl<SPI, REMAP, PINS> crate::hal::spi::FullDuplex<u8> for Spi<SPI, REMAP, PINS>

Original file line number	Diff line number	Diff line change
`@@ -303,9 +303,13 @@ where`
`303`	`303`	`}`
`304`	`304`	`}`
`305`	`305`
	`306`	`+ #[deprecated(since = "0.6.0", note = "Please use release instead")]`
`306`	`307`	`pub fn free(self) -> (SPI, PINS) {`
`307`	`308`	`(self.spi, self.pins)`
`308`	`309`	`}`
	`310`	`+ pub fn release(self) -> (SPI, PINS) {`
	`311`	`+ self.free()`
	`312`	`+ }`
`309`	`313`	`}`
`310`	`314`
`311`	`315`	`impl<SPI, REMAP, PINS> crate::hal::spi::FullDuplex<u8> for Spi<SPI, REMAP, PINS>`