fixing isssues with documentation

Author: Creamy-pie-96

docs/Var/comparison_and_boolean.md

@@ -47,15 +47,24 @@ This page documents all comparison and boolean operations for `var`, using a cle
 ## Examples
 
 ```cpp
-#include "pythonic/pythonicVars.hpp"
-#include "pythonic/pythonicPrint.hpp"
-using namespace pythonic::vars;
-using pythonic::print::print;
+#include <pythonic/pythonic.hpp>
+using namespace py;
 
-var a = 10;
+int main()
+{
+    var a = 10;
 var b = 10.0;
 print(a == b);       // true (numeric promotion)
 print(a != b);       // false
+if(a) // any non-zero number is true
+{
+    print("any non-zero number is true");
+}
+
+if(!(b - 10))
+{
+    print("Any var with value 0 is false");
+}
 
 var s1 = "abc";
 var s2 = "abc";
@@ -84,11 +93,16 @@ print(list(1) || list()); // true
 std::set<var> st = { var(2), var(1) };
 for (auto &v : st) print(v); // 1 2
 
+// Btw a lot of you might try do do this! And you will get an error! So be careful who you compare
+
 try {
     print(dict({{"a",1}}) > list(1));
 } catch (const pythonic::PythonicTypeError &e) {
     print("comparison error:", e.what());
 }
+    return 0;
+}
+
 ```
 
 ---

docs/Var/construction_and_lifetime.md

@@ -20,7 +20,7 @@ This page documents all ways to construct and manage the lifetime of a `var` obj
 | `var(const char*)`        | String                   | `var s("hello"); // "hello"`        |
 | `var(const std::string&)` | String                   | `var s(std::string("hi")); // "hi"` |
 | `var(List/Set/Dict/...)`  | Container types          | `var vlist(list(1,2,3));`           |
-| `var(Graph)`              | Graph (VarGraph wrapper) | `var vg(Graph(5));`                 |
+| `graph(n)`                | Graph (VarGraph wrapper) | `var vg = graph(5);`                |
 
 ---
 
@@ -103,8 +103,9 @@ OrderedDict od = { {"k1", var(1)}, {"k2", var(2)} };
 var vod(od);
 
 // --- Graph Constructor ---
-Graph g(5); g.add_edge(0, 1);
-var vg(g);
+var vg = graph(5); // recommended
+vg.add_edge(0, 1);
+vg.save_graph("mygraph.txt"); // save the graph to a file
 
 // --- Converter Helpers ---
 var vstr = "123";
@@ -128,7 +129,8 @@ var fodset = ordered_set(3, 1, 2);
 var fdict = dict({{"a", 1}, {"b", 2}});
 var fodict = ordered_dict({{"k1", 1}, {"k2", 2}});
 var fgraph = graph(5);
-auto loaded = load_graph("/path/to/graph.file");
+var loaded = load_graph("mygraph.txt"); // load the graph from the file
+//auto loaded = load_graph("/path/to/graph.file");
 
 
 // --- input ---
@@ -157,4 +159,4 @@ print(copy, moved);
 
 ## Next check
 
-- [Type Introspection & Conversion](type_introspection_and_conversion.md)
+- [Type Introspection & Conversion](type_introspection_and_conversion.md)

docs/Var/container_and_sequence_operations.md

@@ -39,41 +39,56 @@ This page documents all user-facing container and sequence APIs for `var`, in a
 ## Examples
 
 ```cpp
-#include "pythonic/pythonic.hpp"
+#include <pythonic/pythonic.hpp>
 using namespace py;
 
-var vlist = list(1, 2, 3);
-vlist.append(4);           // [1,2,3,4]
-vlist.extend(list(5,6));   // [1,2,3,4,5,6]
-vlist.remove(2);           // [1,3,4,5,6]
-print(vlist.len());       // 5
-print(vlist.front());      // 1
-print(vlist.back());       // 6
-print(vlist.at(2));        // 4
-print(vlist[1]);           // 3
-print(vlist.slice(1,4));   // [3,4,5]
-print(vlist(1,4));         // [3,4,5]
-print(vlist.empty());      // false
-vlist.clear();
-print(vlist.empty());      // true
-
-var vset = set(1,2,3);
-vset.add(4);
-vset.update(set(5,6));
-print(vset.contains(3));    // true
-print(vset.has(5));        // true
-vset.remove(1);
-
-var vdict = dict({{"a", 1}, {"b", 2}});
-print(vdict["a"]);        // 1
-print(vdict.keys());       // ["a", "b"]
-print(vdict.values());     // [1,2]
-print(vdict.items());      // [("a",1), ("b",2)]
-
-// Iteration
-for (auto it = vdict.begin(); it != vdict.end(); ++it) {
-    // ...
+int main()
+{
+    var vlist = list(1, 2, 3);
+    vlist.append(4);           // [1,2,3,4]
+    vlist.extend(list(5,6));   // [1,2,3,4,5,6]
+    vlist.remove(2);           // [1,3,4,5,6]
+    print(vlist.len());       // 5
+    print(vlist.front());      // 1
+    print(vlist.back());       // 6
+    print(vlist.at(2));        // 4
+    print(vlist[1]);           // 3
+    print(vlist.slice(1,4));   // [3,4,5]
+    print(vlist(1,4));         // [3,4,5]
+    print(vlist.empty());      // false
+    vlist.clear();
+    print(vlist.empty());      // true
+
+    var vset = set(1,2,3);
+    vset.add(4);
+    vset.update(set(5,6));
+    print(vset.contains(3));    // true
+    print(vset.has(5));        // true
+    vset.remove(1);
+
+    var vdict = dict({{"a", 1}, {"b", 2}});
+    print(vdict["a"]);        // 1
+    print(vdict.keys());       // ["a", "b"]
+    print(vdict.values());     // [1,2]
+    print(vdict.items());      // [("a",1), ("b",2)]
+    for (auto it = vdict.get<Dict>().begin(); it != vdict.get<Dict>().end(); ++it) 
+    {
+        print("key: ", it->first);  // key (std::string)
+        print("value: ", it->second); // value (var)
+    }
+    for (auto [key,value] : vdict.get<Dict>())
+    {
+        print("key: ", key);  // key (std::string)
+        print("value: ", value); // value (var)
+    }
+    for (auto it = vdict.begin(); it != vdict.end(); ++it) 
+    {
+        print(1);
+        // but you can't use it->first and it->second here as the vdict is not a std::map. also you can not do auto[key,value] like iteration directly on vdict, you have to use vdict.get<Dict>() to get the underlying std::map
+    }
+    return 0;
 }
+
 ```
 
 ---