document public methods that take arguments

Alberto Scotta · Alberto Scotta · commit 0c7a18e1ee85 · 2019-06-04T21:40:58.000+02:00
diff --git a/can/interfaces/slcan.py b/can/interfaces/slcan.py
@@ -107,6 +107,12 @@ def __init__(
         )
 
     def set_bitrate(self, bitrate):
+        """
+        :raise ValueError: if both *bitrate* is not among the possible values
+
+        :param int bitrate:
+            Bitrate in bit/s
+        """
         self.close()
         if bitrate in self._BITRATES:
             self.write(self._BITRATES[bitrate])
@@ -117,6 +123,10 @@ def set_bitrate(self, bitrate):
         self.open()
 
     def set_bitrate_reg(self, btr):
+        """
+        :param str btr:
+            BTR register value to set custom can speed
+        """
         self.close()
         self.write("s" + btr)
         self.open()
