style: comment

Author: 0x01f7

algorithms/add_and_search_word_data_structure_design.rb

@@ -18,7 +18,9 @@
 #     search(".ad") -> true
 #     search("b..") -> true
 #
-# Note: You may assume that all words are consist of lowercase letters a-z.
+# Note:
+#
+#     You may assume that all words are consist of lowercase letters a-z.
 
 
 class TrieNode

algorithms/balanced_binary_tree.rb

@@ -1,9 +1,8 @@
 # https://leetcode.com/problems/balanced-binary-tree/
 #
-# Given a binary tree, determine if it is height-balanced. For this
-# problem, a height-balanced binary tree is defined as a binary
-# tree in which the depth of the two subtrees of every node never
-# differ by more than 1.
+# Given a binary tree, determine if it is height-balanced. For this problem,
+# a height-balanced binary tree is defined as a binary tree in which the
+# depth of the two subtrees of every node never differ by more than 1.
 
 
 # Definition for a binary tree node.

algorithms/basic_calculator.rb

@@ -1,9 +1,9 @@
 # https://leetcode.com/problems/basic-calculator/
 #
-# Implement a basic calculator to evaluate a simple expression string.
-# The expression string may contain open ( and closing parentheses ),
-# the plus + or minus sign -, non-negative integers and empty spaces.
-# You may assume that the given expression is always valid.
+# Implement a basic calculator to evaluate a simple expression string. The
+# expression string may contain open ( and closing parentheses ), the plus
+# + or minus sign -, non-negative integers and empty spaces. You may assume
+# that the given expression is always valid.
 #
 # Some examples:
 #

algorithms/basic_calculator_ii.rb

@@ -1,17 +1,24 @@
 # https://leetcode.com/problems/basic-calculator-ii/
 #
-# Implement a basic calculator to evaluate a simple expression string.
-# The expression string contains only non-negative integers, +, -, *,
-# / operators and empty spaces. The integer division should truncate
-# toward zero. You may assume that the given expression is always valid.
+# Implement a basic calculator to evaluate a simple expression string. The
+# expression string contains only non-negative integers, +, -, *, / operators
+# and empty spaces. The integer division should truncate toward zero. You may
+# assume that the given expression is always valid.
 #
 # Some examples:
 #
 #     "3+2*2" = 7
 #     " 3/2 " = 1
 #     " 3+5 / 2 " = 5
 #
-# Note: Do not use the eval built-in library function.
+# Note:
+#
+#     Do not use the eval built-in library function.
+#
+# Credits:
+#
+#     Special thanks to @ts for adding this problem and creating all test
+#     cases.
 
 
 # @param {String} s

algorithms/best_time_to_buy_and_sell_stock.rb

@@ -1,9 +1,9 @@
 # https://leetcode.com/problems/best-time-to-buy-and-sell-stock/
 #
-# Say you have an array for which the ith element is the price of a
-# given stock on day i. If you were only permitted to complete at
-# most one transaction (ie, buy one and sell one share of the stock),
-# design an algorithm to find the maximum profit.
+# Say you have an array for which the ith element is the price of a given
+# stock on day i. If you were only permitted to complete at most one
+# transaction (ie, buy one and sell one share of the stock), design an
+# algorithm to find the maximum profit.
 
 
 # @param {Integer[]} prices

algorithms/best_time_to_buy_and_sell_stock_ii.rb

@@ -1,11 +1,11 @@
 # https://leetcode.com/problems/best-time-to-buy-and-sell-stock-ii/
 #
-# Say you have an array for which the ith element is the price of a
-# given stock on day i. Design an algorithm to find the maximum
-# profit. You may complete as many transactions as you like (ie,
-# buy one and sell one share of the stock multiple times). However,
-# you may not engage in multiple transactions at the same time (ie,
-# you must sell the stock before you buy again).
+# Say you have an array for which the ith element is the price of a given
+# stock on day i. Design an algorithm to find the maximum profit. You may
+# complete as many transactions as you like (ie, buy one and sell one share
+# of the stock multiple times). However, you may not engage in multiple
+# transactions at the same time (ie, you must sell the stock before you buy
+# again).
 
 
 # @param {Integer[]} prices

algorithms/best_time_to_buy_and_sell_stock_iii.rb

@@ -1,10 +1,10 @@
 # https://leetcode.com/problems/best-time-to-buy-and-sell-stock-iii/
 #
-# Say you have an array for which the ith element is the price of a
-# given stock on day i. Design an algorithm to find the maximum
-# profit. You may complete at most two transactions. However,
-# You may not engage in multiple transactions at the same time (ie,
-# you must sell the stock before you buy again).
+# Say you have an array for which the ith element is the price of a given
+# stock on day i. Design an algorithm to find the maximum profit. You may
+# complete at most two transactions. However, You may not engage in multiple
+# transactions at the same time (ie, you must sell the stock before you buy
+# again).
 
 
 # @param {Integer[]} prices

algorithms/best_time_to_buy_and_sell_stock_iv.rb

@@ -1,10 +1,15 @@
 # https://leetcode.com/problems/best-time-to-buy-and-sell-stock-iv/
 #
-# Say you have an array for which the ith element is the price of a
-# given stock on day i. Design an algorithm to find the maximum
-# profit. You may complete at most k transactions. However,
-# You may not engage in multiple transactions at the same time (ie,
-# you must sell the stock before you buy again).
+# Say you have an array for which the ith element is the price of a given
+# stock on day i. Design an algorithm to find the maximum profit. You may
+# complete at most k transactions. However, You may not engage in multiple
+# transactions at the same time (ie, you must sell the stock before you buy
+# again).
+#
+# Credits:
+#
+#     Special thanks to @Freezen for adding this problem and creating all
+#     test cases.
 
 
 # @param {Integer} k

algorithms/binary_search_tree_iterator.rb

@@ -1,12 +1,18 @@
 # https://leetcode.com/problems/binary-search-tree-iterator/
 #
-# Implement an iterator over a binary search tree (BST). Your iterator
-# will be initialized with the root node of a BST.
+# Implement an iterator over a binary search tree (BST). Your iterator will
+# be initialized with the root node of a BST. Calling next() will return the
+# next smallest number in the BST.
 #
-# Calling next() will return the next smallest number in the BST.
+# Note:
 #
-# Note: next() and hasNext() should run in average O(1) time and uses
-# O(h) memory, where h is the height of the tree.
+#     next() and hasNext() should run in average O(1) time and uses O(h)
+#     memory, where h is the height of the tree.
+#
+# Credits:
+#
+#     Special thanks to @ts for adding this problem and creating all test
+#     cases.
 
 
 # Definition for a binary tree node.

algorithms/binary_tree_inorder_traversal.rb

@@ -1,19 +1,18 @@
 # https://leetcode.com/problems/binary-tree-inorder-traversal/
 #
-# Given a binary tree, return the inorder traversal of its nodes'
-# values.
+# Given a binary tree, return the inorder traversal of its nodes' values.
 #
 # For example:
 #
-#     Given binary tree {1,#,2,3},
+#     Given binary tree {1, #, 2, 3},
 #
 #         1
 #          \
 #           2
 #          /
 #         3
 #
-#     return [1,3,2].
+#     Return [1, 3, 2].
 #
 # Note: Recursive solution is trivial, could you do it iteratively?
 

algorithms/binary_tree_level_order_traversal.rb

@@ -1,19 +1,19 @@
 # https://leetcode.com/problems/binary-tree-level-order-traversal/
 #
-# Given a binary tree, return the level order traversal of its
-# nodes' values. (ie, from left to right, level by level).
+# Given a binary tree, return the level order traversal of its nodes' values.
+# (ie, from left to right, level by level).
 #
 # For example:
 #
-#     Given binary tree {3,9,20,#,#,15,7},
+#     Given binary tree {3, 9, 20, #, #, 15, 7},
 #
 #           3
 #          / \
 #         9  20
 #            / \
 #           15  7
 #
-#     return its level order traversal as:
+#     Return its level order traversal as:
 #
 #         [
 #           [3],

algorithms/binary_tree_level_order_traversal_ii.rb

@@ -1,20 +1,19 @@
 # https://leetcode.com/problems/binary-tree-level-order-traversal-ii/
 #
-# Given a binary tree, return the bottom-up level order traversal
-# of its nodes' values. (ie, from left to right, level by level
-# from leaf to root).
+# Given a binary tree, return the bottom-up level order traversal of its
+# nodes' values. (ie, from left to right, level by level from leaf to root).
 #
 # For example:
 #
-#     Given binary tree {3,9,20,#,#,15,7},
+#     Given binary tree {3, 9, 20, #, #, 15, 7},
 #
 #           3
 #          / \
 #         9  20
 #            / \
 #           15  7
 #
-#     return its level order traversal as:
+#     Return its level order traversal as:
 #
 #         [
 #           [15, 7],

algorithms/binary_tree_maximum_path_sum.rb

@@ -1,17 +1,19 @@
 # https://leetcode.com/problems/binary-tree-maximum-path-sum/
 #
-# Given a binary tree, find the maximum path sum. For this problem, a
-# path is defined as any sequence of nodes from some starting node to
-# any node in the tree along the parent-child connections. The path
-# does not need to go through the root.
+# Given a binary tree, find the maximum path sum. For this problem, a path is
+# defined as any sequence of nodes from some starting node to any node in the
+# tree along the parent-child connections. The path does not need to go
+# through the root.
 #
-# For example: Given the below binary tree,
+# For example:
 #
-#       1
-#      / \
-#     2   3
+#     Given the below binary tree:
 #
-# Return 6.
+#           1
+#          / \
+#         2   3
+#
+#     Return 6.
 
 
 # Definition for a binary tree node.

algorithms/binary_tree_paths.rb

@@ -2,17 +2,24 @@
 #
 # Given a binary tree, return all root-to-leaf paths.
 #
-# For example, given the following binary tree:
+# For example,
 #
-#       1
-#      / \
-#     2   3
-#      \
-#       5
+#     Given the following binary tree:
 #
-# All root-to-leaf paths are:
+#           1
+#          / \
+#         2   3
+#          \
+#           5
 #
-#     ["1->2->5", "1->3"]
+#     All root-to-leaf paths are:
+#
+#         ["1->2->5", "1->3"]
+#
+# Credits:
+#
+#     Special thanks to @jianchao.li.fighter for adding this problem and
+#     creating all test cases.
 
 
 # Definition for a binary tree node.

algorithms/binary_tree_postorder_traversal.rb

@@ -1,19 +1,18 @@
 # https://leetcode.com/problems/binary-tree-postorder-traversal/
 #
-# Given a binary tree, return the postorder traversal of its nodes'
-# values.
+# Given a binary tree, return the postorder traversal of its nodes' values.
 #
 # For example:
 #
-#     Given binary tree {1,#,2,3},
+#     Given binary tree {1, #, 2, 3},
 #
 #         1
 #          \
 #           2
 #          /
 #         3
 #
-#     return [3,2,1].
+#     Return [3, 2, 1].
 #
 # Note: Recursive solution is trivial, could you do it iteratively?
 

algorithms/binary_tree_preorder_traversal.rb

@@ -1,19 +1,18 @@
 # https://leetcode.com/problems/binary-tree-preorder-traversal/
 #
-# Given a binary tree, return the preorder traversal of its nodes'
-# values.
+# Given a binary tree, return the preorder traversal of its nodes' values.
 #
 # For example:
 #
-#     Given binary tree {1,#,2,3},
+#     Given binary tree {1, #, 2, 3},
 #
 #         1
 #          \
 #           2
 #          /
 #         3
 #
-#     return [1,2,3].
+#     Return [1, 2, 3].
 #
 # Note: Recursive solution is trivial, could you do it iteratively?
 

algorithms/binary_tree_right_side_view.rb

@@ -1,18 +1,24 @@
 # https://leetcode.com/problems/binary-tree-right-side-view/
 #
-# Given a binary tree, imagine yourself standing on the right side
-# of it, return the values of the nodes you can see ordered from
-# top to bottom.
+# Given a binary tree, imagine yourself standing on the right side of it,
+# return the values of the nodes you can see ordered from top to bottom.
 #
-# For example: Given the following binary tree,
+# For example:
 #
-#       1         <---
-#      / \
-#     2   3       <---
-#      \   \
-#       5   4     <---
+#     Given the following binary tree,
 #
-# You should return [1, 3, 4].
+#           1         <---
+#          / \
+#         2   3       <---
+#          \   \
+#           5   4     <---
+#
+#     Return [1, 3, 4].
+#
+# Credits:
+#
+#     Special thanks to @amrsaqr for adding this problem and creating all
+#     test cases.
 
 
 # Definition for a binary tree node.