modified doc gen

Author: drblallo

docs/sphinx_doc/stdlib/action.md

@@ -10,10 +10,9 @@
 
 ```text
  parses actions taking only one byte and by taking taking the reminder of the parsed number divided by the number of actions, so that no action is ever marked as invalid
-
 ```
 
-- **Function**: `parse_actions<AllActionsVariant>(AllActionsVariant variant, Vector<Byte> input)  -> Vector<AllActionsVariant>`
+ - **Function**: `parse_actions<AllActionsVariant>(AllActionsVariant variant, Vector<Byte> input)  -> Vector<AllActionsVariant>`
 - **Function**: `parse_and_execute<FrameType, AllActionsVariant>(FrameType state, AllActionsVariant variant, Vector<Byte> input) `
 - **Function**: `make_valid_actions_vector<FrameType, ActionType>(Vector<ActionType> all_actions, FrameType state)  -> Vector<Byte>`
 - **Function**: `get_valid_actions<FrameType, ActionType>(Vector<Byte> valid_actions, Vector<ActionType> all_actions, FrameType state) `
@@ -22,10 +21,9 @@
 ```text
  method that bust be present in binary to ensure that all methods 
  required by rlc-learn are available
-
 ```
 
-- **Function**: `load_action_vector_file<ActionType>(String file_name, Vector<ActionType> out)  -> Bool`
+ - **Function**: `load_action_vector_file<ActionType>(String file_name, Vector<ActionType> out)  -> Bool`
 - **Function**: `enumerate(Bool b, Vector<Bool> output) `
 - **Function**: `enumeration_error(Int x, String out, Vector<String> context) `
 - **Function**: `enumeration_error(Float x, String out, Vector<String> context) `
@@ -85,10 +83,9 @@
  
  this is used by machine learning techniques that need to
  enumerate all possible actions.
-
 ```
 
-- **Function**: `enumerate(T obj, Vector<T> output) `
+ - **Function**: `enumerate(T obj, Vector<T> output) `
 
 ## Trait CustomEnumerationError
 
@@ -102,10 +99,9 @@
  a given type is to be converted into a tensor
  for machine learning consumptions. The encoding
  should be, when possible, one-hot encoding.
-
 ```
 
-- **Function**: `write_in_observation_tensor(T obj, Int observer_id, Vector<Float> output, Int counter) `
+ - **Function**: `write_in_observation_tensor(T obj, Int observer_id, Vector<Float> output, Int counter) `
 - **Function**: `size_as_observation_tensor(T obj)  -> Int`
 
 ## Trait CustomTensorWarnings

docs/sphinx_doc/stdlib/algorithms/equal.md

@@ -11,10 +11,9 @@
 
 ```text
  Nof fully impelemted, do not use
-
 ```
 
-
+ 
 ## Traits
 
 ## Trait Comparable

docs/sphinx_doc/stdlib/bounded_arg.md

@@ -8,10 +8,9 @@
  enumerate will return the range of values
  between the two. Machine learning serialization
  will serialize this class as a one-hot vector
-
 ```
 
-### Fields
+ ### Fields
 - `Int value`
 
 ### Methods
@@ -50,10 +49,9 @@
  This class makes sense when it is used to rappresent
  integers that appear with the same frequency for
  each possible value.
-
 ```
 
-### Fields
+ ### Fields
 - `Int value`
 
 ### Methods

docs/sphinx_doc/stdlib/collections/dictionary.md

@@ -16,86 +16,32 @@
 - **Function**: `init() `
 - **Function**: `insert(KeyType key, ValueType value)  -> Bool`
 - **Function**: `get(KeyType key)  -> ValueType`
-
-```text
- Add safety counter
- Create local copies of key and value to avoid modifying the input parameters
- Add safety check to prevent infinite loops
- Update the actual entry in entries
- Update the actual entry in entries
- Update the swapped entry
-
-```
-
 - **Function**: `contains(KeyType key)  -> Bool`
-
-```text
- Quick return for empty dictionary
- Add safety counter
- Add safety check to prevent infinite loops
-
-```
-
 - **Function**: `remove(KeyType key)  -> Bool`
-
-```text
- Quick return for empty dictionary
- Add safety counter
- Add safety check to prevent infinite loops
-
-```
-
 - **Function**: `keys()  -> Vector<KeyType>`
-
-```text
- Add safety counter
- Add safety check to prevent infinite loops
- Perform backward-shift operation
- Shift elements until we find an empty slot or an element with probe distance 0
- Calculate probe distance of the next element
- If probe distance is 0, it's already at its ideal position
- Move the element back
- Move to next positions
-
-```
-
 - **Function**: `values()  -> Vector<ValueType>`
 - **Function**: `empty()  -> Bool`
 
 ```text
  returns true if the
  size of the dictionary is equal
  to zero
-
 ```
 
-- **Function**: `size()  -> Int`
+ - **Function**: `size()  -> Int`
 
 ```text
  returns true if the
  size of the dictionary is equal
  to zero
-
 ```
 
-- **Function**: `clear() `
+ - **Function**: `clear() `
 
 ```text
  erases all the elements
  of the dictionary
-
-```
-
-- **Function**: `drop() `
-
-```text
- Create new, larger entries array
- Ensures growth by at least 1
- Initialize new entries
- Copy old entries to new array, but only scan up to old_capacity
- Insert directly without triggering another growth
- Clean up old entries
-
 ```
 
+ - **Function**: `drop() `
 

docs/sphinx_doc/stdlib/collections/pair.md

@@ -5,10 +5,9 @@
 
 ```text
  A parameterized container with two fields, first and second
-
 ```
 
-### Fields
+ ### Fields
 - `T1 first`
 - `T2 second`
 
@@ -21,7 +20,6 @@
  a vector with length equal to the shortest of the lengths of the 
  two input vectors. output.get(i).first == x.get(i) and 
  output.get(i).second == y.get(i) for all i from 0 to output.length()
-
 ```
 
-
+