Better class signatures in docs (#3996)

quiltdata · Jun 7, 2024 · 64e081c · 64e081c
1 parent 2e9ae0c
commit 64e081c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/.github/workflows/py-ci.yml b/.github/workflows/py-ci.yml
@@ -54,7 +54,7 @@ jobs:
       - name: install deps
         run: |
           python -m pip install --upgrade pip setuptools
-          python -m pip install api/python nbconvert git+https://github.com/quiltdata/pydoc-markdown.git@quilt
+          python -m pip install api/python nbconvert git+https://github.com/quiltdata/pydoc-markdown.git@v2.0.5+quilt3.2
       - name: generate docs
         run: cd gendocs && python build.py
       - name: show invisible changes via cat

diff --git a/docs/api-reference/Bucket.md b/docs/api-reference/Bucket.md
@@ -1,5 +1,5 @@
 
-# Bucket(self, bucket\_uri)  {#Bucket}
+# Bucket(bucket\_uri)  {#Bucket}
 Bucket interface for Quilt.
 
 **\_\_init\_\_**

diff --git a/docs/api-reference/Package.md b/docs/api-reference/Package.md
@@ -1,5 +1,5 @@
 
-# Package(self)  {#Package}
+# Package()  {#Package}
 In-memory representation of a package
 
 ## manifest
@@ -400,7 +400,7 @@ __Returns__
 True if the package matches the directory; False otherwise.
 
 
-# PackageEntry(self, physical\_key, size, hash\_obj, meta)  {#PackageEntry}
+# PackageEntry(physical\_key, size, hash\_obj, meta)  {#PackageEntry}
 Represents an entry at a logical key inside a package.
 
 **\_\_init\_\_**

diff --git a/gendocs/build.py b/gendocs/build.py
@@ -41,7 +41,7 @@ def install_pydocmd():
     except metadata.PackageNotFoundError:
         version = None
 
-    if version and version.endswith(EXPECTED_VERSION_SUFFIX):
+    if version and EXPECTED_VERSION_SUFFIX in version:
         return
 
     valid_input = ['y', 'n', 'yes', 'no']
@@ -75,7 +75,7 @@ def install_pydocmd():
 
     import pydocmd
 
-    if not pydocmd.__version__.endswith(EXPECTED_VERSION_SUFFIX):
+    if EXPECTED_VERSION_SUFFIX not in pydocmd.__version__:
         print("Please re-run this script to continue")
         exit()