Rename serial raw_read to read_data_register

Author: Sh3Rm4n

CHANGELOG.md

@@ -45,6 +45,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   the dependencies where using the MIT / Apache 2.0 dual licensing already,
   which resulted into the situtation, that BSD 0-clause was not affectivly
   0-clause as MIT conditions had to be met anyways. (🧂 IANAL). ([#309])
+- Renamed `Serial::raw_read` to `Serial::read_data_register`. ([#281])
 - Move ADC from a macro to a generic implementation, meaning that
   it is possible to obtain an ADC instance via `Adc::new` instead of
   `Adc::adc1`. ([#281])

src/serial.rs

@@ -576,8 +576,13 @@ where
     /// the triggered events via [`Serial::triggered_events`].
     ///
     /// Returns `None` if the hardware is busy.
+    ///
+    /// ## Embedded HAL
+    ///
+    /// To have a more managed way to read from the serial use the [`embedded_hal::serial::Read`]
+    /// trait implementation.
     #[doc(alias = "RDR")]
-    pub fn raw_read(&self) -> Option<u8> {
+    pub fn read_data_register(&self) -> Option<u8> {
         if self.usart.isr.read().busy().bit_is_set() {
             return None;
         }
@@ -907,7 +912,7 @@ where
     /// up to the interrupt handler.
     ///
     /// To read out the content of the read register without internal error handling, use
-    /// [`Serial::raw_read()`].
+    /// [`Serial::read_data_register()`].
     /// ...
     // -> According to this API it should be skipped.
     fn read(&mut self) -> nb::Result<u8, Error> {