Rename length variable to height.

Author: Tim-ats-d

README.md

@@ -73,13 +73,13 @@ from visualdialog import DialogBox
 
 
 x, y = (0, 0)
-length, width = (35, 6)
+height, width = (35, 6)
 
 def main(stdscr):
     curses.curs_set(False)
 
     textbox = DialogBox(x, y,
-                        length, width,
+                        height, width,
                         title="Demo")
     textbox.char_by_char(stdscr,
                          "Hello world")
@@ -116,6 +116,8 @@ You can also generate the documentation in **Latex**, **Texinfo** or **man-pages
 
 We would love for you to contribute to improve **Visual-dialog**.
 
+For major changes, please open an issue first to discuss what you would like to change.
+
 Take a look at our [contributing guide](CONTRIBUTING.md) to get started.
 You can also help by reporting **bugs**.
 

examples/confrontation.py

@@ -20,27 +20,27 @@ def main(stdscr):
     curses.init_pair(2, curses.COLOR_MAGENTA, curses.COLOR_BLACK)
     curses.init_pair(3, curses.COLOR_RED, curses.COLOR_BLACK)
 
-    width, length  = 6, 35  # Width and length (in character).
+    width, height  = 6, 35  # Width and height (in character).
 
     max_y, max_x = stdscr.getmaxyx()
 
     left_x = 2  # Left alignment.
-    right_x = max_x - length - 4 # Calculation of right alignment.
-    center_x = max_x // 2 - length // 2  # Calculation of center alignment.
+    right_x = max_x - height - 4 # Calculation of right alignment.
+    center_x = max_x // 2 - height // 2  # Calculation of center alignment.
     bottom_y = max_y - width - 4  # Calculation of bottom alignment.
 
     phoenix_wright = DialogBox(left_x, bottom_y,
-                               length, width,
+                               height, width,
                                title="Phoenix",
                                title_colors_pair_nb=1)  # Title and color_pair used to colored title.
 
     april_may = DialogBox(center_x, bottom_y,
-                          length, width,
+                          height, width,
                           title="April",
                           title_colors_pair_nb=2)
 
     miles_edgeworth = DialogBox(right_x, bottom_y,
-                                length, width,
+                                height, width,
                                 title="Edgeworth",
                                 title_colors_pair_nb=3)
 

visualdialog/box.py

@@ -61,7 +61,7 @@ class BaseTextBox:
     :param pos_y: y position of the dialog box in ``curses`` window
         object on which methods will have effects.
 
-    :param length: Length of the dialog box in ``curses`` window object
+    :param height: Height of the dialog box in ``curses`` window object
         on which methods will have effects.
 
     :param width: Width of the dialog box in ``curses`` window object on
@@ -97,7 +97,7 @@ def __init__(
         self,
         pos_x: int,
         pos_y: int,
-        length: int,
+        height: int,
         width: int,
         title: str = "",
         title_colors_pair_nb: int = 0,
@@ -107,7 +107,7 @@ def __init__(
                             List[str]] = (",", ".", ":", ";", "!", "?"),
         downtime_chars_delay: Number = .6):
         self.pos_x, self.pos_y = pos_x, pos_y
-        self.length, self.width = length, width
+        self.height, self.width = height, width
 
         self.title_offsetting_y = 2 if title else 0
 
@@ -116,7 +116,7 @@ def __init__(
         # Compensation for the upper border of the dialog box.
         self.text_pos_y = pos_y + self.title_offsetting_y + 1
 
-        self.nb_char_max_line = length - 4
+        self.nb_char_max_line = height - 4
         self.nb_lines_max = width - 2
 
         self.title = title
@@ -149,9 +149,9 @@ def position(self) -> Tuple[int]:
     def dimensions(self) -> Tuple[int]:
         """Returns a tuple contains dimensions of ``TextBox``.
 
-        :returns: Length and width of ``TextBox``.
+        :returns: Height and width of ``TextBox``.
         """
-        return self.length, self.width
+        return self.height, self.width
 
     def framing_box(self, win: CursesWindow):
         """Displays dialog box borders and his title.
@@ -184,7 +184,7 @@ def framing_box(self, win: CursesWindow):
                                  self.pos_y + self.title_offsetting_y,
                                  self.pos_x,
                                  self.pos_y + self.title_offsetting_y + self.width,
-                                 self.pos_x + self.length)
+                                 self.pos_x + self.height)
 
     def getkey(self, win: CursesWindow):
         """Blocks execution as long as a key contained in

visualdialog/dialog.py

@@ -63,7 +63,7 @@ def __init__(
         self,
         pos_x: int,
         pos_y: int,
-        length: int,
+        height: int,
         width: int,
         title: str = "",
         title_colors_pair_nb: int = 0,
@@ -75,13 +75,13 @@ def __init__(
         end_indicator: str = "►"):
         BaseTextBox.__init__(self,
                              pos_x, pos_y,
-                             length, width,
+                             height, width,
                              title,
                              title_colors_pair_nb, title_text_attr,
                              downtime_chars, downtime_chars_delay)
 
         self.end_indicator_char = end_indicator
-        self.end_indicator_pos_x = self.pos_x + self.length - 2
+        self.end_indicator_pos_x = self.pos_x + self.height - 2
 
         if self.title:
             self.end_indicator_pos_y = self.pos_y + self.width + 1