Merge pull request PrefectHQ#311 from PrefectHQ/small-changes

Three small changes
Rogell · Nov 1, 2018 · e42fce4 · e42fce4
2 parents 40e0307 + 93e6de5
commit e42fce4
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 123 deletions.
diff --git a/.gitignore b/.gitignore
@@ -120,5 +120,6 @@ node_modules
 
 # docs
 docs/api
+docs/changelog.md
 docs/deploy/dist
 docs/.vuepress/public/prefect-coverage
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/generate_docs.py b/docs/generate_docs.py
@@ -488,6 +488,8 @@ def get_class_methods(obj):
     shutil.rmtree("api", ignore_errors=True)
     os.makedirs("api", exist_ok=True)
     generate_coverage()
+
+    ## UPDATE README
     with open("api/README.md", "w+") as f:
         f.write(
             textwrap.dedent(
@@ -516,6 +518,23 @@ def get_class_methods(obj):
             f.write("\n" + readme[readme.index("# Prefect") :])
             f.write(auto_generated_footer)
 
+    ## UPDATE CHANGELOG
+    with open("changelog.md", "w+") as f:
+        f.write(
+            textwrap.dedent(
+                """
+            ---
+            sidebarDepth: 1
+            editLink: false
+            ---
+            """
+            ).lstrip()
+        )
+        with open("../CHANGELOG.md", "r") as g:
+            changelog = g.read()
+            f.write(changelog)
+            f.write(auto_generated_footer)
+
     for page in OUTLINE:
         # collect what to document
         fname, classes, fns = (

diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 
 install_requires = [
     "click >= 6.7, < 7.0",
-    "cloudpickle == 0.5.3",
+    "cloudpickle >= 0.6.0",
     "croniter >= 0.3.23, < 0.4",
     "cryptography >= 2.2.2, < 3.0",
     "dask >= 0.18, < 0.19",

diff --git a/src/prefect/utilities/collections.py b/src/prefect/utilities/collections.py
@@ -36,7 +36,9 @@ def flatten_seq(seq: Iterable) -> Generator:
 class DotDict(MutableMapping):
     """
     A `dict` that also supports attribute ("dot") access. Think of this as an extension
-    to the standard python `dict` object.
+    to the standard python `dict` object.  **Note**: while any hashable object can be added to
+    a `DotDict`, _only_ valid Python identifiers can be accessed with the dot syntax; this excludes
+    strings which begin in numbers, special characters, or double underscores.
 
     Args:
         - init_dict (dict, optional): dictionary to initialize the `DotDict`