diff --git a/.all-contributorsrc b/.all-contributorsrc index 22edabd..f5e5230 100644 --- 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 deleted file mode 100644 index e69de29..0000000 diff --git a/LICENSE.md b/LICENSE.md index cb99cce..ec43c7a 100644 --- 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 index 84147d5..2a3b9f9 100644 --- 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 method ```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 index 7e2f681..628448b 100644 --- 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: + +
Justin DuJardin |
+ JT Stukes |
+