Skip to content

Commit 9e2f852

Browse files
Tune ups to docstrings from code review
Co-authored-by: Isaac To <candleindark@users.noreply.github.com>
1 parent 4e1c7db commit 9e2f852

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

dandi/dandiapi.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -648,20 +648,20 @@ def create_dandiset(
648648

649649
def check_schema_version(self, schema_version: str | None = None) -> None:
650650
"""
651-
Confirms that the server is using a "compatible" version of the DANDI schema.
651+
Confirms that the the given schema version at the client is "compatible" the server.
652652
653653
Compatibility here means that the server's schema version can be either
654654
655655
- lower than client has, but within the same MAJOR.MINOR component of the version
656656
number for 0.x series, and same MAJOR version for/after 1.x series.
657-
- higher than client has, but only if the client's schema version is listed
657+
- otherwise, but only if the client's schema version is listed
658658
among the server's `allowed_schema_versions` (as returned by the `/info` API endpoint),
659659
or if not there -- `dandischema.consts.ALLOWED_INPUT_SCHEMAS` is consulted.
660660
661661
If neither of above, a `SchemaVersionError` is raised.
662662
663-
:param schema_version: the schema version to confirm that the server
664-
uses; if not set, the schema version for the installed
663+
:param schema_version: the schema version to be confirmed for compatibility with the server;
664+
if not set, the schema version for the installed
665665
``dandischema`` library is used
666666
"""
667667
if schema_version is None:

0 commit comments

Comments
 (0)