docs: add contributors to website home

mathy · Dec 15, 2023 · c2ba6ee · c2ba6ee
1 parent 05f5843
commit c2ba6ee
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 10 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -4,7 +4,8 @@
   "repoType": "github",
   "repoHost": "https://github.com",
   "files": [
-    "README.md"
+    "README.md",
+    "website/docs/index.md"
   ],
   "imageSize": 100,
   "commit": true,

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2011 - 2020 Justin DuJardin
+Copyright © 2011 Justin DuJardin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

diff --git a/README.md b/README.md
@@ -323,10 +323,10 @@ Returns true if the given type is part of this set
 
 ```python (doc)
 BinaryTreeNode(
-    self,
-    left: Optional[BinaryTreeNode] = None,
-    right: Optional[BinaryTreeNode] = None,
-    parent: Optional[BinaryTreeNode] = None,
+    self: ~NodeType,
+    left: Optional[~NodeType] = None,
+    right: Optional[~NodeType] = None,
+    parent: Optional[~NodeType] = None,
     id: Optional[str] = None,
 )
 ```
@@ -364,7 +364,7 @@ Return the root element of this tree
 ### get_root_side <kbd>method</kbd>
 
 ```python (doc)
-BinaryTreeNode.get_root_side(self: 'BinaryTreeNode') -> Literal['left', 'right']
+BinaryTreeNode.get_root_side(self: ~NodeType) -> Literal['left', 'right']
 ```
 
 Return the side of the tree that this node lives on
@@ -383,7 +383,7 @@ has no sibling, the return value will be None.
 ```python (doc)
 BinaryTreeNode.get_side(
     self,
-    child: Optional[BinaryTreeNode],
+    child: Optional[~NodeType],
 ) -> Literal['left', 'right']
 ```
 
@@ -412,7 +412,7 @@ the order of the nodes in the tree.
 ```python (doc)
 BinaryTreeNode.set_left(
     self: ~NodeType,
-    child: Optional[BinaryTreeNode] = None,
+    child: Optional[~NodeType] = None,
     clear_old_child_parent: bool = False,
 ) -> ~NodeType
 ```
@@ -424,7 +424,7 @@ Set the left node to the passed `child`
 ```python (doc)
 BinaryTreeNode.set_right(
     self: ~NodeType,
-    child: Optional[BinaryTreeNode] = None,
+    child: Optional[~NodeType] = None,
     clear_old_child_parent: bool = False,
 ) -> ~NodeType
 ```

diff --git a/website/docs/index.md b/website/docs/index.md
@@ -63,3 +63,27 @@ Mathy can also transform the parsed Expression trees using rules that change the
 {!./snippets/cas/overview/rules_factor_out.py!}
 
 ```
+
+## Contributors
+
+Mathy Core wouldn't be possible without the contributions of the following people:
+
+<div class="contributors-wrapper">
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a target="_blank" href="https://www.justindujardin.com/"><img src="https://avatars0.githubusercontent.com/u/101493?v=4" width="100px;" alt=""/><br /><sub><b>Justin DuJardin</b></sub></a></td>
+      <td align="center" valign="top" width="14.28%"><a target="_blank" href="https://github.com/ElSupreme"><img src="https://avatars.githubusercontent.com/u/13594721?v=4" width="100px;" alt=""/><br /><sub><b>JT Stukes</b></sub></a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+</div>
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!