Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better class signatures in docs #3996

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Better class signatures in docs #3996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/py-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/Bucket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Bucket(self, bucket\_uri) {#Bucket}
# Bucket(bucket\_uri) {#Bucket}
Bucket interface for Quilt.

**\_\_init\_\_**
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/Package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Package(self) {#Package}
# Package() {#Package}
In-memory representation of a package

## manifest
Expand Down Expand Up @@ -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\_\_**
Expand Down
4 changes: 2 additions & 2 deletions gendocs/build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down Expand Up @@ -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()

Expand Down